doc/doxygen/doxygen.conf.in

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