Optimize Doxygen build
[gromacs/AngularHB.git] / doxygen / Doxyfile-common.cmakein
blobe9e6ac8ed521d750f39ded5edd55e70fdeb0648c
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 EXCLUDE_SYMBOLS       += GMX_TEST_OPTIONS
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@
27 ENABLED_SECTIONS       = @DOXYGEN_SECTIONS@
29 # Extract documentation also for code in headers within #ifdef __cplusplus
30 PREDEFINED             = __cplusplus
31 # This is for thread_mpi to #ifdef some code out that should not be documented.
32 PREDEFINED            += DOXYGEN
33 # This is for parser.cpp to make it produce code that Doxygen understands
34 # and that does not have unnecessary function declarations.
35 PREDEFINED            += __STDC__ YYMALLOC=malloc YYFREE=free
37 JAVADOC_AUTOBRIEF      = YES
38 BUILTIN_STL_SUPPORT    = YES
39 INLINE_INHERITED_MEMB  = YES
40 SORT_BY_SCOPE_NAME     = YES
41 ALPHABETICAL_INDEX     = YES
42 HTML_DYNAMIC_SECTIONS  = YES
43 GENERATE_LATEX         = NO
44 # Setting this to NO has a side effect to hide undocumented headers from the
45 # file list, which makes it generally look nicer.
46 VERBATIM_HEADERS       = NO
48 EXTRACT_LOCAL_CLASSES  = NO
50 ALIASES               += Gromacs=GROMACS
52 DOT_IMAGE_FORMAT       = svg
53 DOT_MULTI_TARGETS      = YES
54 # According to Doxygen docs, this is required for svg support on IE
55 HTML_FILE_EXTENSION    = .xhtml