Skip to content
Snippets Groups Projects
Doxystyle 7.25 KiB
Newer Older
  • Learn to ignore specific revisions
  • #----------- Doxystyle -----------
    
    ##################################################################################
    # Project Details:
    
    PROJECT_NAME           = @DUNE_MOD_NAME@
    PROJECT_NUMBER         = @DUNE_MOD_VERSION@
    
    ##################################################################################
    # What to parse
    
    RECURSIVE              = YES
    FILE_PATTERNS          = *.hh \
                             *.cc
    INPUT                  =
    
    EXCLUDE_PATTERNS       = */.svn/* */test/*
    
    
    # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
    # in the INCLUDE_PATH (see below) will be search if a #include is found.
    
    SEARCH_INCLUDES        = NO # don't warn about missing stl-headers etc.
    
    
    # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
    # the path mentioned in the documentation of a class, which tells
    # the reader which header file to include in order to use a class.
    # If left blank only the name of the header file containing the class
    # definition is used. Otherwise one should specify the include paths that
    # are normally passed to the compiler using the -I flag.
    
    STRIP_FROM_INC_PATH    = @abs_top_srcdir@
    
    
    WARNINGS               = YES
    WARN_IF_UNDOCUMENTED   = YES
    WARN_IF_DOC_ERROR      = YES
    WARN_NO_PARAMDOC       = NO
    
    WARN_LOGFILE           = doxyerr.log
    
    #################################################################################
    # Styling
    
    # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
    # inherited members of a class in the documentation of that class as if those
    # members were ordinary class members. Constructors, destructors and assignment
    # operators of the base classes will not be shown.
    
    INLINE_INHERITED_MEMB  = YES
    
    # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
    # path before files name in the file list and in the header files. If set
    # to NO the shortest path that makes the file name unique will be used.
    
    FULL_PATH_NAMES        = NO
    
    # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
    # (but less readable) file names. This can be useful is your file systems
    # doesn't support long names like on DOS, Mac, or CD-ROM.
    
    @DUNEWEB_TRUE@SHORT_NAMES            = NO
    @DUNEWEB_FALSE@SHORT_NAMES            = YES
    
    # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
    # to include (a tag file for) the STL sources as input, then you should
    # set this tag to YES in order to let doxygen match functions declarations and
    # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
    # func(std::string) {}). This also make the inheritance and collaboration
    # diagrams that involve STL classes more complete and accurate.
    
    BUILTIN_STL_SUPPORT    = YES
    
    # If the EXTRACT_STATIC tag is set to YES all static members of a file
    # will be included in the documentation.
    
    EXTRACT_STATIC         = YES
    
    # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
    # undocumented members of documented classes, files or namespaces.
    # If set to NO (the default) these members will be included in the
    # various overviews, but no documentation section is generated.
    # This option has no effect if EXTRACT_ALL is enabled.
    
    
    HIDE_UNDOC_MEMBERS     = NO
    
    
    # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
    # undocumented classes that are normally visible in the class hierarchy.
    # If set to NO (the default) these classes will be included in the various
    # overviews. This option has no effect if EXTRACT_ALL is enabled.
    
    HIDE_UNDOC_CLASSES     = YES
    
    # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
    # friend (class|struct|union) declarations.
    # If set to NO (the default) these declarations will be included in the
    # documentation.
    
    HIDE_FRIEND_COMPOUNDS  = YES
    
    # The INTERNAL_DOCS tag determines if documentation
    # that is typed after a \internal command is included. If the tag is set
    # to NO (the default) then the documentation will be excluded.
    # Set it to YES to include the internal documentation.
    
    INTERNAL_DOCS          = YES
    
    # If the sources in your project are distributed over multiple directories
    # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
    # in the documentation. The default is NO.
    
    
    REFERENCED_BY_RELATION = NO
    REFERENCES_RELATION    = NO
    
    ALPHABETICAL_INDEX     = YES
    COLS_IN_ALPHA_INDEX    = 3
    HTML_OUTPUT            = html
    
    SEARCHENGINE           = NO
    
    
    GENERATE_TODOLIST      = YES
    GENERATE_TESTLIST      = YES
    GENERATE_BUGLIST       = YES
    GENERATE_DEPRECATEDLIST= YES
    
    GENERATE_HTML          = YES
    GENERATE_DOCSET        = NO
    GENERATE_HTMLHELP      = NO
    GENERATE_CHI           = NO
    GENERATE_QHP           = NO
    GENERATE_TREEVIEW      = NO
    
    GENERATE_LATEX         = NO
    GENERATE_RTF           = NO
    GENERATE_MAN           = NO
    GENERATE_XML           = NO
    GENERATE_AUTOGEN_DEF   = NO
    GENERATE_PERLMOD       = NO
    GENERATE_TAGFILE       =
    GENERATE_LEGEND        = NO
    
    MACRO_EXPANSION        = YES
    EXPAND_ONLY_PREDEF     = YES
    PREDEFINED             = DOXYGEN \
                             HAVE_MPI:=1 \
                             _DEBUG_ALLOCATOR_H:=1 \
    
                             "DUNE_DEPRECATED_MSG(A):=/** \deprecated A */"
    
    @DOT_TRUE@HAVE_DOT               = YES
    
    
    # If set to YES, the inheritance and collaboration graphs will show the
    # relations between templates and their instances.
    
    TEMPLATE_RELATIONS     = YES
    CLASS_GRAPH            = YES
    
    COLLABORATION_GRAPH    = NO
    
    GROUP_GRAPHS           = YES
    
    INCLUDE_GRAPH          = NO
    INCLUDED_BY_GRAPH      = NO
    
    GRAPHICAL_HIERARCHY    = NO
    DOT_MULTI_TARGETS      = NO
    GENERATE_LEGEND        = NO
    DOT_CLEANUP            = NO
    
    ####################################################################
    # Header Footer and Stylesheet in use is controled by the Makefile #
    #                                           (christi 16. Jan 2006) #
    ####################################################################
    
    
    # The HTML_HEADER tag can be used to specify a personal HTML header for
    # each generated HTML page. If it is left blank doxygen will generate a
    
    # standard header.
    
    @DUNEWEB_TRUE@HTML_HEADER            = doxy-header.html
    @DUNEWEB_FALSE@HTML_HEADER            =
    
    
    # The HTML_FOOTER tag can be used to specify a personal HTML footer for
    # each generated HTML page. If it is left blank doxygen will generate a
    
    # standard footer.
    
    @DUNEWEB_TRUE@HTML_FOOTER            = doxy-footer.html
    @DUNEWEB_FALSE@HTML_FOOTER            =
    
    ##########################  DOXYGEN DOXYSTYLE
    EXTRACT_ALL            = YES
    EXTRACT_PRIVATE        = NO
    EXTRACT_STATIC         = YES
    EXTRACT_LOCAL_CLASSES  = YES
    EXTRACT_LOCAL_METHODS  = NO
    EXTRACT_ANON_NSPACES   = NO
    HIDE_UNDOC_MEMBERS     = NO
    HIDE_UNDOC_CLASSES     = NO
    
    HIDE_FRIEND_COMPOUNDS  = YES
    
    HIDE_IN_BODY_DOCS      = NO
    INTERNAL_DOCS          = NO
    CASE_SENSE_NAMES       = NO
    HIDE_SCOPE_NAMES       = NO
    SHOW_INCLUDE_FILES     = YES
    INLINE_INFO            = YES
    SORT_MEMBER_DOCS       = YES
    SORT_BRIEF_DOCS        = NO
    SORT_MEMBERS_CTORS_1ST = NO
    SORT_GROUP_NAMES       = NO
    SORT_BY_SCOPE_NAME     = NO
    GENERATE_TODOLIST      = YES
    GENERATE_TESTLIST      = YES
    GENERATE_BUGLIST       = YES
    GENERATE_DEPRECATEDLIST= YES
    
    ENABLED_SECTIONS       =
    
    MAX_INITIALIZER_LINES  = 30
    SHOW_FILES             = YES
    SHOW_NAMESPACES        = YES
    
    FILE_VERSION_FILTER    =
    LAYOUT_FILE            =