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