Doxyfile

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