git.meshlink.io Git - catta/blob - doxygen.cfg

   1 # Doxyfile 1.3.7
   2
   3 #---------------------------------------------------------------------------
   4 # Project related configuration options
   5 #---------------------------------------------------------------------------
   6 PROJECT_NAME           = $(PROJECT)
   7 PROJECT_NUMBER         = $(VERSION)
   8 OUTPUT_DIRECTORY       = $(DOCDIR)
   9 CREATE_SUBDIRS         = NO
  10 OUTPUT_LANGUAGE        = English
  11 USE_WINDOWS_ENCODING   = NO
  12 BRIEF_MEMBER_DESC      = YES
  13 REPEAT_BRIEF           = YES
  14 ABBREVIATE_BRIEF       =
  15 ALWAYS_DETAILED_SEC    = NO
  16 INLINE_INHERITED_MEMB  = NO
  17 STRIP_FROM_INC_PATH    = $(SRCDIR)
  18 FULL_PATH_NAMES        = YES
  19 STRIP_FROM_PATH        = $(SRCDIR)
  20 SHORT_NAMES            = NO
  21 JAVADOC_AUTOBRIEF      = YES
  22 MULTILINE_CPP_IS_BRIEF = NO
  23 DETAILS_AT_TOP         = YES
  24 INHERIT_DOCS           = YES
  25 DISTRIBUTE_GROUP_DOC   = NO
  26 TAB_SIZE               = 4
  27 ALIASES                =
  28 OPTIMIZE_OUTPUT_FOR_C  = YES
  29 OPTIMIZE_OUTPUT_JAVA   = NO
  30 SUBGROUPING            = YES
  31 #---------------------------------------------------------------------------
  32 # Build related configuration options
  33 #---------------------------------------------------------------------------
  34 EXTRACT_ALL            = YES
  35 EXTRACT_PRIVATE        = NO
  36 EXTRACT_STATIC         = NO
  37 EXTRACT_LOCAL_CLASSES  = YES
  38 EXTRACT_LOCAL_METHODS  = NO
  39 HIDE_UNDOC_MEMBERS     = NO
  40 HIDE_UNDOC_CLASSES     = NO
  41 HIDE_FRIEND_COMPOUNDS  = NO
  42 HIDE_IN_BODY_DOCS      = NO
  43 INTERNAL_DOCS          = NO
  44 CASE_SENSE_NAMES       = NO
  45 HIDE_SCOPE_NAMES       = NO
  46 SHOW_INCLUDE_FILES     = YES
  47 INLINE_INFO            = YES
  48 SORT_MEMBER_DOCS       = YES
  49 SORT_BRIEF_DOCS        = NO
  50 SORT_BY_SCOPE_NAME     = NO
  51 GENERATE_TODOLIST      = YES
  52 GENERATE_TESTLIST      = YES
  53 GENERATE_BUGLIST       = YES
  54 GENERATE_DEPRECATEDLIST= YES
  55 ENABLED_SECTIONS       =
  56 MAX_INITIALIZER_LINES  = 30
  57 SHOW_USED_FILES        = YES
  58 SHOW_DIRECTORIES       = NO
  59 #---------------------------------------------------------------------------
  60 # configuration options related to warning and progress messages
  61 #---------------------------------------------------------------------------
  62 QUIET                  = NO
  63 WARNINGS               = YES
  64 WARN_IF_UNDOCUMENTED   = YES
  65 WARN_IF_DOC_ERROR      = YES
  66 WARN_FORMAT            = "$file:$line: $text"
  67 WARN_LOGFILE           =
  68 #---------------------------------------------------------------------------
  69 # configuration options related to the input files
  70 #---------------------------------------------------------------------------
  71 INPUT                  = $(INPUT)
  72 FILE_PATTERNS          =
  73 RECURSIVE              = NO
  74 EXCLUDE                =
  75 EXCLUDE_SYMLINKS       = NO
  76 EXCLUDE_PATTERNS       =
  77 EXAMPLE_PATH           = $(EXAMPLE_PATH)
  78 EXAMPLE_PATTERNS       = $(EXAMPLE_PATTERNS)
  79 EXAMPLE_RECURSIVE      = NO
  80 IMAGE_PATH             =
  81 INPUT_FILTER           =
  82 FILTER_SOURCE_FILES    = NO
  83 #---------------------------------------------------------------------------
  84 # configuration options related to source browsing
  85 #---------------------------------------------------------------------------
  86 SOURCE_BROWSER         = YES
  87 INLINE_SOURCES         = NO
  88 STRIP_CODE_COMMENTS    = YES
  89 REFERENCED_BY_RELATION = YES
  90 REFERENCES_RELATION    = YES
  91 VERBATIM_HEADERS       = YES
  92 #---------------------------------------------------------------------------
  93 # configuration options related to the alphabetical class index
  94 #---------------------------------------------------------------------------
  95 ALPHABETICAL_INDEX     = YES
  96 COLS_IN_ALPHA_INDEX    = 5
  97 IGNORE_PREFIX          = Catta CATTA_ catta_
  98 #---------------------------------------------------------------------------
  99 # configuration options related to the HTML output
 100 #---------------------------------------------------------------------------
 101 GENERATE_HTML          = $(GENERATE_HTML)
 102 HTML_OUTPUT            = html
 103 HTML_FILE_EXTENSION    = .html
 104 HTML_HEADER            =
 105 HTML_FOOTER            =
 106 HTML_STYLESHEET        =
 107 HTML_ALIGN_MEMBERS     = YES
 108 GENERATE_HTMLHELP      = $(GENERATE_CHM)
 109 CHM_FILE               = ../$(PROJECT).chm
 110 HHC_LOCATION           = $(HHC_PATH)
 111 GENERATE_CHI           = $(GENERATE_CHI)
 112 BINARY_TOC             = NO
 113 TOC_EXPAND             = NO
 114 DISABLE_INDEX          = NO
 115 ENUM_VALUES_PER_LINE   = 1
 116 GENERATE_TREEVIEW      = YES
 117 TREEVIEW_WIDTH         = 250
 118 #---------------------------------------------------------------------------
 119 # configuration options related to the LaTeX output
 120 #---------------------------------------------------------------------------
 121 GENERATE_LATEX         = $(GENERATE_LATEX)
 122 LATEX_OUTPUT           = latex
 123 LATEX_CMD_NAME         = latex
 124 MAKEINDEX_CMD_NAME     = makeindex
 125 COMPACT_LATEX          = NO
 126 PAPER_TYPE             = $(PAPER_SIZE)
 127 EXTRA_PACKAGES         =
 128 LATEX_HEADER           =
 129 PDF_HYPERLINKS         = NO
 130 USE_PDFLATEX           = NO
 131 LATEX_BATCHMODE        = YES
 132 LATEX_HIDE_INDICES     = NO
 133 #---------------------------------------------------------------------------
 134 # configuration options related to the RTF output
 135 #---------------------------------------------------------------------------
 136 GENERATE_RTF           = $(GENERATE_RTF)
 137 RTF_OUTPUT             = rtf
 138 COMPACT_RTF            = NO
 139 RTF_HYPERLINKS         = NO
 140 RTF_STYLESHEET_FILE    =
 141 RTF_EXTENSIONS_FILE    =
 142 #---------------------------------------------------------------------------
 143 # configuration options related to the man page output
 144 #---------------------------------------------------------------------------
 145 GENERATE_MAN           = $(GENERATE_MAN)
 146 MAN_OUTPUT             = man
 147 MAN_EXTENSION          = .1
 148 MAN_LINKS              = NO
 149 #---------------------------------------------------------------------------
 150 # configuration options related to the XML output
 151 #---------------------------------------------------------------------------
 152 GENERATE_XML           = $(GENERATE_XML)
 153 XML_OUTPUT             = xml
 154 XML_SCHEMA             =
 155 XML_DTD                =
 156 XML_PROGRAMLISTING     = YES
 157 #---------------------------------------------------------------------------
 158 # configuration options for the AutoGen Definitions output
 159 #---------------------------------------------------------------------------
 160 GENERATE_AUTOGEN_DEF   = NO
 161 #---------------------------------------------------------------------------
 162 # configuration options related to the Perl module output
 163 #---------------------------------------------------------------------------
 164 GENERATE_PERLMOD       = NO
 165 PERLMOD_LATEX          = NO
 166 PERLMOD_PRETTY         = YES
 167 PERLMOD_MAKEVAR_PREFIX =
 168 #---------------------------------------------------------------------------
 169 # Configuration options related to the preprocessor
 170 #---------------------------------------------------------------------------
 171 ENABLE_PREPROCESSING   = YES
 172 MACRO_EXPANSION        = YES
 173 EXPAND_ONLY_PREDEF     = YES
 174 SEARCH_INCLUDES        = YES
 175 INCLUDE_PATH           =
 176 INCLUDE_FILE_PATTERNS  =
 177 PREDEFINED             = "DOXYGEN_SHOULD_SKIP_THIS" "CATTA_C_DECL_BEGIN=" "CATTA_C_DECL_END="
 178 EXPAND_AS_DEFINED      =
 179 SKIP_FUNCTION_MACROS   = YES
 180 #---------------------------------------------------------------------------
 181 # Configuration::additions related to external references
 182 #---------------------------------------------------------------------------
 183 TAGFILES               =
 184 GENERATE_TAGFILE       = $(DOCDIR)/$(PROJECT).tag
 185 ALLEXTERNALS           = NO
 186 EXTERNAL_GROUPS        = YES
 187 PERL_PATH              = $(PERL_PATH)
 188 #---------------------------------------------------------------------------
 189 # Configuration options related to the dot tool
 190 #---------------------------------------------------------------------------
 191 CLASS_DIAGRAMS         = NO
 192 HIDE_UNDOC_RELATIONS   = NO
 193 HAVE_DOT               = $(HAVE_DOT)
 194 CLASS_GRAPH            = NO
 195 COLLABORATION_GRAPH    = NO
 196 UML_LOOK               = NO
 197 TEMPLATE_RELATIONS     = NO
 198 INCLUDE_GRAPH          = NO
 199 INCLUDED_BY_GRAPH      = NO
 200 CALL_GRAPH             = NO
 201 GRAPHICAL_HIERARCHY    = NO
 202 DOT_IMAGE_FORMAT       = png
 203 DOT_PATH               = $(DOT_PATH)
 204 DOTFILE_DIRS           =
 205 MAX_DOT_GRAPH_WIDTH    = 1024
 206 MAX_DOT_GRAPH_HEIGHT   = 1024
 207 MAX_DOT_GRAPH_DEPTH    = 0
 208 GENERATE_LEGEND        = YES
 209 DOT_CLEANUP            = YES
 210 #---------------------------------------------------------------------------
 211 # Configuration::additions related to the search engine
 212 #---------------------------------------------------------------------------
 213 SEARCHENGINE           = NO