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 EXAMPLE_PATH           = @CMAKE_SOURCE_DIR@
   8 RECURSIVE              = YES
   9 EXCLUDE                = @CMAKE_SOURCE_DIR@/doxygen/examples \
  10                          @CMAKE_SOURCE_DIR@/src/contrib \
  11                          @CMAKE_SOURCE_DIR@/src/external \
  12                          @CMAKE_SOURCE_DIR@/src/gromacs/legacyheaders/thread_mpi/atomic \
  13                          @CMAKE_SOURCE_DIR@/src/gromacs/selection/parser.cpp \
  14                          @CMAKE_SOURCE_DIR@/src/gromacs/selection/scanner.cpp @NB_KERNEL_DIRS_TO_IGNORE_IN_DOXYGEN@
  15 EXCLUDE_SYMBOLS        = YY* yy* _gmx_sel_yy*
  16 EXCLUDE_SYMBOLS       += TEST TEST_F TEST_P TYPED_TEST_CASE TYPED_TEST INSTANTIATE_TEST_CASE_P
  17 EXCLUDE_SYMBOLS       += MOCK_METHOD* MOCK_CONST_METHOD*
  18 FULL_PATH_NAMES        = YES
  19 STRIP_FROM_PATH        = @CMAKE_SOURCE_DIR@
  20 STRIP_FROM_INC_PATH    = @CMAKE_SOURCE_DIR@/src
  21 INCLUDE_PATH           = @CMAKE_SOURCE_DIR@/src \
  22                          @CMAKE_SOURCE_DIR@/src/gromacs/legacyheaders
  23 HAVE_DOT               = @DOXYGEN_DOT_FOUND@
  24 DOT_PATH               = @DOXYGEN_DOT_PATH@
  25 MSCGEN_PATH            = @DOXYGEN_MSCGEN_PATH@
  26
  27 ENABLED_SECTIONS       = @DOXYGEN_SECTIONS@
  28
  29 MACRO_EXPANSION        = YES
  30 EXPAND_ONLY_PREDEF     = YES
  31 # Extract documentation also for code in headers within #ifdef __cplusplus
  32 PREDEFINED             = __cplusplus
  33 # This is for thread_mpi to #ifdef some code out that should not be documented.
  34 PREDEFINED            += DOXYGEN
  35 # This makes 'static gmx_inline' functions appear better in the documentation.
  36 PREDEFINED            += gmx_inline=inline
  37 # This is for parser.cpp to make it produce code that Doxygen understands
  38 # and that does not have unnecessary function declarations.
  39 PREDEFINED            += __STDC__ YYMALLOC=malloc YYFREE=free
  40
  41 JAVADOC_AUTOBRIEF      = YES
  42 BUILTIN_STL_SUPPORT    = YES
  43 INLINE_INHERITED_MEMB  = YES
  44 SORT_BY_SCOPE_NAME     = YES
  45 ALPHABETICAL_INDEX     = YES
  46 HTML_DYNAMIC_SECTIONS  = YES
  47 GENERATE_LATEX         = NO
  48 # Setting this to NO has a side effect to hide undocumented headers from the
  49 # file list, which makes it generally look nicer.
  50 VERBATIM_HEADERS       = NO
  51 STRIP_CODE_COMMENTS    = NO
  52
  53 EXTRACT_LOCAL_CLASSES  = NO
  54
  55 ALIASES               += Gromacs=GROMACS
  56
  57 DOT_IMAGE_FORMAT       = svg
  58 DOT_MULTI_TARGETS      = YES
  59 # According to Doxygen docs, this is required for svg support on IE
  60 HTML_FILE_EXTENSION    = .xhtml