Make nbnxm headers more self-contained
[alexxy/gromacs.git] / docs / doxygen / suppressions.txt
1 # The script is currently a bit too eager
2 share/template/template.cpp: error: source file documentation appears outside full documentation
3 # The parser in the script is not clever enough
4 src/gromacs/version.h: warning: includes local file as <gromacs/version.h>
5
6 # These are OK
7 src/gromacs/linearalgebra/eigensolver.cpp: warning: should include "config.h"
8 src/gromacs/linearalgebra/gmx_arpack.cpp: warning: should include "config.h"
9 src/gromacs/linearalgebra/gmx_blas/*: warning: does not include "gmxpre.h" first
10 src/gromacs/linearalgebra/gmx_blas/*: warning: should include "config.h"
11 src/gromacs/linearalgebra/gmx_lapack/*: warning: does not include "gmxpre.h" first
12 src/gromacs/linearalgebra/gmx_lapack/*: warning: should include "config.h"
13 src/gromacs/utility/baseversion-gen.cpp: warning: does not include "gmxpre.h" first
14
15 # Exclude header files that are used for inlining code; the responsibility for
16 # making the right #includes should be on the source file that uses these.
17 # TODO: # Stop using the preprocessor for meta-programming!
18 src/gromacs/ewald/pme_simd4.h: warning: should include "pme_simd.h"
19 src/gromacs/ewald/pme_spline_work.cpp: warning: includes "simd.h" unnecessarily
20 src/gromacs/ewald/pme_spline_work.h: warning: includes "simd.h" unnecessarily
21 src/gromacs/ewald/pme_spread.cpp: warning: includes "simd.h" unnecessarily
22 src/gromacs/nbnxm/boundingboxes.h: warning: includes "simd.h" unnecessarily
23 src/gromacs/nbnxm/kernels_simd_2xmm/kernel_inner.h: warning: should include "simd.h"
24 src/gromacs/nbnxm/kernels_simd_2xmm/kernel_outer.h: warning: should include "simd.h"
25 src/gromacs/nbnxm/kernels_simd_4xm/kernel_inner.h: warning: should include "simd.h"
26 src/gromacs/nbnxm/kernels_simd_4xm/kernel_outer.h: warning: should include "simd.h"
27 src/gromacs/nbnxm/pairlist_simd_2xmm.h: warning: should include "simd.h"
28 src/gromacs/nbnxm/pairlist_simd_4xm.h: warning: should include "simd.h"
29
30 # This module name doesn't really fall into any currently used pattern; needs some thought
31 : error: no matching directory for module: module_mdrun_integration_tests
32
33 # These would be nice to fix, but can wait for later / deletion / rewrites
34 src/gromacs/nbnxm/kernels_simd_2xmm/kernel_common.h: warning: should include "nbnxm_simd.h"
35 src/gromacs/nbnxm/kernels_simd_4xm/kernel_common.h: warning: should include "nbnxm_simd.h"
36
37 # This seems to be a false positive
38 src/gromacs/nbnxm/cuda/nbnxm_cuda_types.h: error: gmx_nbnxm_gpu_t: is in internal file(s), but appears in public documentation
39
40 # Temporary while we change the SIMD implementation
41 src/gromacs/simd/impl_sparc64_hpc_ace/impl_sparc64_hpc_ace_common.h: warning: should include "simd.h"
42
43 src/gromacs/simd/tests/scalar.cpp: warning: includes "simd.h" unnecessarily
44 src/gromacs/simd/tests/scalar_math.cpp: warning: includes "simd.h" unnecessarily
45 src/gromacs/simd/tests/scalar_util.cpp: warning: includes "simd.h" unnecessarily
46 src/gromacs/tables/cubicsplinetable.h: warning: includes "simd.h" unnecessarily
47 src/gromacs/tables/quadraticsplinetable.h: warning: includes "simd.h" unnecessarily
48
49 # These are specific to Folding@Home, and easiest to suppress here
50 *: warning: includes non-local file as "corewrap.h"
51 src/gmxpre.h: warning: includes non-local file as "swindirect.h"
52
53 # New external API (see https://redmine.gromacs.org/issues/2586) has some unresolved
54 # conflicts with previous definitions of public API, installed API, and other things
55 # described or implemented in check-source.py, gmxtree.py, gmxtree.rst, and others
56 # TODO: resolve definitions, update testing heuristics, and activate policy checks
57 # for src/api/cpp files.
58 src/api/cpp/*: *
59
60 # doxygen has problems with the template construct in this file
61 src/gromacs/modularsimulator/signallers.h: error: build: is documented, but does not have brief description