docs/doxygen/suppressions.txt

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