doc/Doxyfile.in

   1 # Doxyfile 1.5.4
   2
   3 #---------------------------------------------------------------------------
   4 # Project related configuration options
   5 #---------------------------------------------------------------------------
   6 DOXYFILE_ENCODING      = UTF-8
   7 PROJECT_NAME           = Geany
   8 PROJECT_NUMBER         = @VERSION@
   9 OUTPUT_DIRECTORY       = ./
  10 CREATE_SUBDIRS         = NO
  11 OUTPUT_LANGUAGE        = English
  12 BRIEF_MEMBER_DESC      = YES
  13 REPEAT_BRIEF           = YES
  14 ABBREVIATE_BRIEF       = "The $name class " \
  15                          "The $name widget " \
  16                          "The $name file " \
  17                          is \
  18                          provides \
  19                          specifies \
  20                          contains \
  21                          represents \
  22                          a \
  23                          an \
  24                          the
  25 ALWAYS_DETAILED_SEC    = NO
  26 INLINE_INHERITED_MEMB  = NO
  27 FULL_PATH_NAMES        = NO
  28 STRIP_FROM_PATH        =
  29 STRIP_FROM_INC_PATH    =
  30 SHORT_NAMES            = NO
  31 JAVADOC_AUTOBRIEF      = YES
  32 QT_AUTOBRIEF           = NO
  33 MULTILINE_CPP_IS_BRIEF = NO
  34 INHERIT_DOCS           = YES
  35 SEPARATE_MEMBER_PAGES  = NO
  36 TAB_SIZE               = 4
  37 # ALIASES taken from pidgin
  38 ALIASES                = "signal=- @ref  " \
  39                          "signaldef=@subsection  " \
  40                          "endsignaldef=  " \
  41                          "signalproto=@code  " \
  42                          "endsignalproto=@endcode  " \
  43                          "signaldesc=" \
  44                          "signals=@b Signals:  " \
  45                          "endsignals=  "
  46 OPTIMIZE_OUTPUT_FOR_C  = YES
  47 OPTIMIZE_OUTPUT_JAVA   = NO
  48 BUILTIN_STL_SUPPORT    = NO
  49 CPP_CLI_SUPPORT        = NO
  50 SIP_SUPPORT            = NO
  51 DISTRIBUTE_GROUP_DOC   = NO
  52 SUBGROUPING            = YES
  53 TYPEDEF_HIDES_STRUCT   = NO
  54 #---------------------------------------------------------------------------
  55 # Build related configuration options
  56 #---------------------------------------------------------------------------
  57 EXTRACT_ALL            = NO
  58 EXTRACT_PRIVATE        = NO
  59 EXTRACT_STATIC         = NO
  60 EXTRACT_LOCAL_CLASSES  = YES
  61 EXTRACT_LOCAL_METHODS  = NO
  62 EXTRACT_ANON_NSPACES   = NO
  63 HIDE_UNDOC_MEMBERS     = YES
  64 HIDE_UNDOC_CLASSES     = YES
  65 HIDE_FRIEND_COMPOUNDS  = NO
  66 HIDE_IN_BODY_DOCS      = YES
  67 INTERNAL_DOCS          = NO
  68 CASE_SENSE_NAMES       = YES
  69 HIDE_SCOPE_NAMES       = NO
  70 SHOW_INCLUDE_FILES     = NO
  71 INLINE_INFO            = NO
  72 SORT_MEMBER_DOCS       = YES
  73 SORT_BRIEF_DOCS        = YES
  74 SORT_BY_SCOPE_NAME     = NO
  75 GENERATE_TODOLIST      = YES
  76 GENERATE_TESTLIST      = NO
  77 GENERATE_BUGLIST       = YES
  78 GENERATE_DEPRECATEDLIST= YES
  79 ENABLED_SECTIONS       =
  80 MAX_INITIALIZER_LINES  = 30
  81 SHOW_USED_FILES        = NO
  82 SHOW_DIRECTORIES       = NO
  83 FILE_VERSION_FILTER    =
  84 #---------------------------------------------------------------------------
  85 # configuration options related to warning and progress messages
  86 #---------------------------------------------------------------------------
  87 QUIET                  = YES
  88 WARNINGS               = YES
  89 WARN_IF_UNDOCUMENTED   = YES
  90 WARN_IF_DOC_ERROR      = YES
  91 WARN_NO_PARAMDOC       = YES
  92 WARN_FORMAT            = "$file:$line: $text "
  93 WARN_LOGFILE           =
  94 #---------------------------------------------------------------------------
  95 # configuration options related to the input files
  96 #---------------------------------------------------------------------------
  97 INPUT                  = ../src/ ./ \
  98                          ../plugins/pluginmacros.h ../plugins/geanyplugin.h ../plugins/geanyfunctions.h \
  99                          ../tagmanager/tm_source_file.c ../tagmanager/include/tm_source_file.h \
 100                          ../tagmanager/tm_work_object.c ../tagmanager/include/tm_work_object.h \
 101                          ../tagmanager/tm_workspace.c ../tagmanager/include/tm_workspace.h
 102 INPUT_ENCODING         = UTF-8
 103 FILE_PATTERNS          = *.c \
 104                          *.cc \
 105                          *.cxx \
 106                          *.cpp \
 107                          *.c++ \
 108                          *.h \
 109                          *.hh \
 110                          *.hxx \
 111                          *.hpp \
 112                          *.h++ \
 113                          *.dox \
 114                          *.py \
 115                          *.C \
 116                          *.CC \
 117                          *.C++ \
 118                          *.H \
 119                          *.HH \
 120                          *.H++ \
 121                          *.dox \
 122 RECURSIVE              = NO
 123 EXCLUDE                =
 124 EXCLUDE_SYMLINKS       = NO
 125 EXCLUDE_PATTERNS       =
 126 EXCLUDE_SYMBOLS        =
 127 EXAMPLE_PATH           =
 128 EXAMPLE_PATTERNS       = *
 129 EXAMPLE_RECURSIVE      = NO
 130 IMAGE_PATH             =
 131 INPUT_FILTER           =
 132 FILTER_PATTERNS        =
 133 FILTER_SOURCE_FILES    = NO
 134 #---------------------------------------------------------------------------
 135 # configuration options related to source browsing
 136 #---------------------------------------------------------------------------
 137 SOURCE_BROWSER         = NO
 138 INLINE_SOURCES         = NO
 139 STRIP_CODE_COMMENTS    = YES
 140 REFERENCED_BY_RELATION = NO
 141 REFERENCES_RELATION    = NO
 142 REFERENCES_LINK_SOURCE = YES
 143 USE_HTAGS              = NO
 144 VERBATIM_HEADERS       = NO
 145 #---------------------------------------------------------------------------
 146 # configuration options related to the alphabetical class index
 147 #---------------------------------------------------------------------------
 148 ALPHABETICAL_INDEX     = NO
 149 COLS_IN_ALPHA_INDEX    = 5
 150 IGNORE_PREFIX          =
 151 #---------------------------------------------------------------------------
 152 # configuration options related to the HTML output
 153 #---------------------------------------------------------------------------
 154 GENERATE_HTML          = YES
 155 HTML_OUTPUT            = reference/
 156 HTML_FILE_EXTENSION    = .html
 157 HTML_HEADER            =
 158 HTML_FOOTER            =
 159 HTML_STYLESHEET        =
 160 HTML_ALIGN_MEMBERS     = YES
 161 GENERATE_HTMLHELP      = NO
 162 HTML_DYNAMIC_SECTIONS  = NO
 163 CHM_FILE               =
 164 HHC_LOCATION           =
 165 GENERATE_CHI           = NO
 166 BINARY_TOC             = NO
 167 TOC_EXPAND             = NO
 168 DISABLE_INDEX          = NO
 169 ENUM_VALUES_PER_LINE   = 4
 170 GENERATE_TREEVIEW      = NO
 171 TREEVIEW_WIDTH         = 250
 172 #---------------------------------------------------------------------------
 173 # configuration options related to the LaTeX output
 174 #---------------------------------------------------------------------------
 175 GENERATE_LATEX         = NO
 176 LATEX_OUTPUT           = latex
 177 LATEX_CMD_NAME         = latex
 178 MAKEINDEX_CMD_NAME     = makeindex
 179 COMPACT_LATEX          = NO
 180 PAPER_TYPE             = a4wide
 181 EXTRA_PACKAGES         =
 182 LATEX_HEADER           =
 183 PDF_HYPERLINKS         = NO
 184 USE_PDFLATEX           = NO
 185 LATEX_BATCHMODE        = NO
 186 LATEX_HIDE_INDICES     = NO
 187 #---------------------------------------------------------------------------
 188 # configuration options related to the RTF output
 189 #---------------------------------------------------------------------------
 190 GENERATE_RTF           = NO
 191 RTF_OUTPUT             = rtf
 192 COMPACT_RTF            = NO
 193 RTF_HYPERLINKS         = NO
 194 RTF_STYLESHEET_FILE    =
 195 RTF_EXTENSIONS_FILE    =
 196 #---------------------------------------------------------------------------
 197 # configuration options related to the man page output
 198 #---------------------------------------------------------------------------
 199 GENERATE_MAN           = NO
 200 MAN_OUTPUT             = man
 201 MAN_EXTENSION          = .3
 202 MAN_LINKS              = NO
 203 #---------------------------------------------------------------------------
 204 # configuration options related to the XML output
 205 #---------------------------------------------------------------------------
 206 GENERATE_XML           = NO
 207 XML_OUTPUT             = xml
 208 XML_SCHEMA             =
 209 XML_DTD                =
 210 XML_PROGRAMLISTING     = YES
 211 #---------------------------------------------------------------------------
 212 # configuration options for the AutoGen Definitions output
 213 #---------------------------------------------------------------------------
 214 GENERATE_AUTOGEN_DEF   = NO
 215 #---------------------------------------------------------------------------
 216 # configuration options related to the Perl module output
 217 #---------------------------------------------------------------------------
 218 GENERATE_PERLMOD       = NO
 219 PERLMOD_LATEX          = NO
 220 PERLMOD_PRETTY         = YES
 221 PERLMOD_MAKEVAR_PREFIX =
 222 #---------------------------------------------------------------------------
 223 # Configuration options related to the preprocessor
 224 #---------------------------------------------------------------------------
 225 ENABLE_PREPROCESSING   = YES
 226 MACRO_EXPANSION        = YES
 227 EXPAND_ONLY_PREDEF     = YES
 228 SEARCH_INCLUDES        = NO
 229 INCLUDE_PATH           =
 230 INCLUDE_FILE_PATTERNS  =
 231 # make G_GNUC_PRINTF a no-op unless doxygen would ignore functions with varargs
 232 PREDEFINED             = "G_GNUC_PRINTF(x,y)=" HAVE_PLUGINS GEANY_FUNCTIONS_H
 233 EXPAND_AS_DEFINED      =
 234 SKIP_FUNCTION_MACROS   = NO
 235 #---------------------------------------------------------------------------
 236 # Configuration::additions related to external references
 237 #---------------------------------------------------------------------------
 238 TAGFILES               =
 239 GENERATE_TAGFILE       =
 240 ALLEXTERNALS           = NO
 241 EXTERNAL_GROUPS        = YES
 242 PERL_PATH              = /usr/bin/perl
 243 #---------------------------------------------------------------------------
 244 # Configuration options related to the dot tool
 245 #---------------------------------------------------------------------------
 246 CLASS_DIAGRAMS         = NO
 247 MSCGEN_PATH            =
 248 HIDE_UNDOC_RELATIONS   = YES
 249 HAVE_DOT               = NO
 250 CLASS_GRAPH            = YES
 251 COLLABORATION_GRAPH    = YES
 252 GROUP_GRAPHS           = YES
 253 UML_LOOK               = NO
 254 TEMPLATE_RELATIONS     = NO
 255 INCLUDE_GRAPH          = YES
 256 INCLUDED_BY_GRAPH      = YES
 257 CALL_GRAPH             = NO
 258 CALLER_GRAPH           = NO
 259 GRAPHICAL_HIERARCHY    = YES
 260 DIRECTORY_GRAPH        = YES
 261 DOT_IMAGE_FORMAT       = png
 262 DOT_PATH               =
 263 DOTFILE_DIRS           =
 264 DOT_GRAPH_MAX_NODES    = 50
 265 MAX_DOT_GRAPH_DEPTH    = 1000
 266 DOT_TRANSPARENT        = YES
 267 DOT_MULTI_TARGETS      = NO
 268 GENERATE_LEGEND        = YES
 269 DOT_CLEANUP            = YES
 270 #---------------------------------------------------------------------------
 271 # Configuration::additions related to the search engine
 272 #---------------------------------------------------------------------------
 273 SEARCHENGINE           = NO