docs/doxygen/Doxyfile-common.cmakein

   1 PROJECT_NAME           = @CMAKE_PROJECT_NAME@
   2 @INCLUDE               = Doxyfile-version
   3 LAYOUT_FILE            = @CMAKE_CURRENT_SOURCE_DIR@/DoxygenLayout.xml
   4 INPUT                  = @CMAKE_CURRENT_SOURCE_DIR@ \
   5                          @CMAKE_SOURCE_DIR@/src \
   6                          @CMAKE_SOURCE_DIR@/share/template
   7 FILE_PATTERNS          = *.c *.cpp *.h *.md
   8 # CUDA files could be included like this, but currently produce a lot of
   9 # warnings.
  10 # FILE_PATTERNS         += *.cu *.cuh
  11 EXAMPLE_PATH           = @CMAKE_SOURCE_DIR@
  12 RECURSIVE              = YES
  13 EXCLUDE                = @CMAKE_SOURCE_DIR@/src/external \
  14                          @CMAKE_SOURCE_DIR@/src/gromacs/linearalgebra/gmx_blas \
  15                          @CMAKE_SOURCE_DIR@/src/gromacs/linearalgebra/gmx_lapack \
  16                          @CMAKE_SOURCE_DIR@/src/gromacs/selection/parser.cpp \
  17                          @CMAKE_SOURCE_DIR@/src/gromacs/selection/parser.h \
  18                          @CMAKE_SOURCE_DIR@/src/gromacs/selection/scanner.cpp @NB_KERNEL_DIRS_TO_IGNORE_IN_DOXYGEN@
  19 EXCLUDE_PATTERNS       = @CMAKE_SOURCE_DIR@/src/gromacs/simd/impl_x86* \
  20                          @CMAKE_SOURCE_DIR@/src/gromacs/simd/impl_intel* \
  21                          @CMAKE_SOURCE_DIR@/src/gromacs/simd/impl_ibm* \
  22                          @CMAKE_SOURCE_DIR@/src/gromacs/simd/impl_arm* \
  23                          @CMAKE_SOURCE_DIR@/src/gromacs/simd/impl_sparc* \
  24                          @CMAKE_SOURCE_DIR@/src/gromacs/simd/impl_none
  25 EXCLUDE_SYMBOLS        = YY* yy* _gmx_sel_yy*
  26 EXCLUDE_SYMBOLS       += __STDC*
  27 EXCLUDE_SYMBOLS       += TEST TEST_F TEST_P TYPED_TEST_CASE TYPED_TEST INSTANTIATE_TEST_CASE_P
  28 EXCLUDE_SYMBOLS       += MOCK_METHOD* MOCK_CONST_METHOD*
  29 FULL_PATH_NAMES        = YES
  30 STRIP_FROM_PATH        = @CMAKE_SOURCE_DIR@
  31 STRIP_FROM_INC_PATH    = @CMAKE_SOURCE_DIR@/src
  32 INCLUDE_PATH           = @CMAKE_SOURCE_DIR@/src
  33 HAVE_DOT               = @DOXYGEN_DOT_FOUND@
  34 DOT_PATH               = @DOXYGEN_DOT_PATH@
  35 MSCGEN_PATH            = @DOXYGEN_MSCGEN_PATH@
  36 DOTFILE_DIRS           = @DEPGRAPH_DIR@
  37 @DOXYGEN_EXTRA_SETTINGS@
  38
  39 ENABLED_SECTIONS       = @DOXYGEN_SECTIONS@
  40
  41 MACRO_EXPANSION        = YES
  42 # Extract documentation also for code in headers within #ifdef __cplusplus
  43 PREDEFINED             = __cplusplus
  44 # This is for cases where \cond does not work, so that #ifndef can also be used.
  45 # thread_mpi also uses this, but it is now excluded from the documentation.
  46 PREDEFINED            += DOXYGEN
  47 # This makes 'static gmx_inline' functions appear better in the documentation.
  48 PREDEFINED            += gmx_inline=inline
  49 # This is for parser.cpp to make it produce code that Doxygen understands
  50 # and that does not have unnecessary function declarations.
  51 PREDEFINED            += __STDC__ YYMALLOC=malloc YYFREE=free
  52
  53 JAVADOC_AUTOBRIEF      = YES
  54 BUILTIN_STL_SUPPORT    = YES
  55 INLINE_INHERITED_MEMB  = YES
  56 SORT_BY_SCOPE_NAME     = YES
  57 ALPHABETICAL_INDEX     = YES
  58 HTML_DYNAMIC_SECTIONS  = YES
  59 GENERATE_LATEX         = NO
  60 # Setting this to NO has a side effect to hide undocumented headers from the
  61 # file list, which makes it generally look nicer.
  62 VERBATIM_HEADERS       = NO
  63 STRIP_CODE_COMMENTS    = NO
  64
  65 EXTRACT_LOCAL_CLASSES  = NO
  66 # This includes 'static inline' functions from headers in the documentation.
  67 EXTRACT_STATIC         = YES
  68
  69 ALIASES               += Gromacs=GROMACS
  70 ALIASES               += linktodevmanual{2}="<A HREF=\"../../dev-manual/\1.html\">\2</A>"
  71 ALIASES               += linktodevmanual{3}="<A HREF=\"../../dev-manual/\1.html#\2\">\3</A>"
  72
  73 DOT_IMAGE_FORMAT       = svg
  74 DOT_MULTI_TARGETS      = YES
  75 # According to Doxygen docs, this is required for svg support on IE
  76 HTML_FILE_EXTENSION    = .xhtml
  77
  78 OUTPUT_DIRECTORY       = @HTML_OUTPUT_DIR@/doxygen