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: NbnxmGpu: is in internal file(s), but appears in public documentation
  39
  40 # False positive caused by forward-declaration of BasicVector in src/testutils/refdata.h
  41 src/gromacs/math/vectypes.h: error: gmx::BasicVector: is in library file(s), but appears in public documentation
  42
  43 # Temporary while we change the SIMD implementation
  44 src/gromacs/simd/impl_sparc64_hpc_ace/impl_sparc64_hpc_ace_common.h: warning: should include "simd.h"
  45
  46 src/gromacs/simd/tests/scalar.cpp: warning: includes "simd.h" unnecessarily
  47 src/gromacs/simd/tests/scalar_math.cpp: warning: includes "simd.h" unnecessarily
  48 src/gromacs/simd/tests/scalar_util.cpp: warning: includes "simd.h" unnecessarily
  49 src/gromacs/tables/cubicsplinetable.h: warning: includes "simd.h" unnecessarily
  50 src/gromacs/tables/quadraticsplinetable.h: warning: includes "simd.h" unnecessarily
  51
  52 # These are specific to Folding@Home, and easiest to suppress here
  53 src/gmxpre.h: warning: includes non-local file as "swindirect.h"
  54
  55 # New external API (see https://gitlab.com/gromacs/gromacs/-/issues/2586) has some unresolved
  56 # conflicts with previous definitions of public API, installed API, and other things
  57 # described or implemented in check-source.py, gmxtree.py, gmxtree.rst, and others
  58 # TODO: resolve definitions, update testing heuristics, and activate policy checks
  59 # for src/api/cpp files.
  60 src/api/cpp/*: *
  61
  62 # doxygen has problems with the template construct in this file
  63 src/gromacs/modularsimulator/signallers.h: error: build: is documented, but does not have brief description