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