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