Doxyfile
changeset 3 0446eb7b28aa
equal deleted inserted replaced
2:86af6c333601 3:0446eb7b28aa
       
     1 # Doxyfile 1.5.5
       
     2 
       
     3 #---------------------------------------------------------------------------
       
     4 # Project related configuration options
       
     5 #---------------------------------------------------------------------------
       
     6 DOXYFILE_ENCODING      = UTF-8
       
     7 PROJECT_NAME           = SMF
       
     8 PROJECT_NUMBER         = 
       
     9 OUTPUT_DIRECTORY       = doc
       
    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        = YES
       
    28 STRIP_FROM_PATH        = 
       
    29 STRIP_FROM_INC_PATH    = 
       
    30 SHORT_NAMES            = NO
       
    31 JAVADOC_AUTOBRIEF      = NO
       
    32 QT_AUTOBRIEF           = NO
       
    33 MULTILINE_CPP_IS_BRIEF = NO
       
    34 DETAILS_AT_TOP         = NO
       
    35 INHERIT_DOCS           = YES
       
    36 SEPARATE_MEMBER_PAGES  = NO
       
    37 TAB_SIZE               = 8
       
    38 ALIASES                = 
       
    39 OPTIMIZE_OUTPUT_FOR_C  = NO
       
    40 OPTIMIZE_OUTPUT_JAVA   = NO
       
    41 OPTIMIZE_FOR_FORTRAN   = NO
       
    42 OPTIMIZE_OUTPUT_VHDL   = NO
       
    43 BUILTIN_STL_SUPPORT    = NO
       
    44 CPP_CLI_SUPPORT        = NO
       
    45 SIP_SUPPORT            = NO
       
    46 DISTRIBUTE_GROUP_DOC   = NO
       
    47 SUBGROUPING            = YES
       
    48 TYPEDEF_HIDES_STRUCT   = NO
       
    49 #---------------------------------------------------------------------------
       
    50 # Build related configuration options
       
    51 #---------------------------------------------------------------------------
       
    52 EXTRACT_ALL            = YES
       
    53 EXTRACT_PRIVATE        = YES
       
    54 EXTRACT_STATIC         = YES
       
    55 EXTRACT_LOCAL_CLASSES  = YES
       
    56 EXTRACT_LOCAL_METHODS  = NO
       
    57 EXTRACT_ANON_NSPACES   = NO
       
    58 HIDE_UNDOC_MEMBERS     = NO
       
    59 HIDE_UNDOC_CLASSES     = NO
       
    60 HIDE_FRIEND_COMPOUNDS  = NO
       
    61 HIDE_IN_BODY_DOCS      = NO
       
    62 INTERNAL_DOCS          = NO
       
    63 CASE_SENSE_NAMES       = NO
       
    64 HIDE_SCOPE_NAMES       = NO
       
    65 SHOW_INCLUDE_FILES     = YES
       
    66 INLINE_INFO            = YES
       
    67 SORT_MEMBER_DOCS       = YES
       
    68 SORT_BRIEF_DOCS        = NO
       
    69 SORT_GROUP_NAMES       = NO
       
    70 SORT_BY_SCOPE_NAME     = NO
       
    71 GENERATE_TODOLIST      = YES
       
    72 GENERATE_TESTLIST      = YES
       
    73 GENERATE_BUGLIST       = YES
       
    74 GENERATE_DEPRECATEDLIST= YES
       
    75 ENABLED_SECTIONS       = 
       
    76 MAX_INITIALIZER_LINES  = 30
       
    77 SHOW_USED_FILES        = YES
       
    78 SHOW_DIRECTORIES       = NO
       
    79 FILE_VERSION_FILTER    = 
       
    80 #---------------------------------------------------------------------------
       
    81 # configuration options related to warning and progress messages
       
    82 #---------------------------------------------------------------------------
       
    83 QUIET                  = NO
       
    84 WARNINGS               = YES
       
    85 WARN_IF_UNDOCUMENTED   = YES
       
    86 WARN_IF_DOC_ERROR      = YES
       
    87 WARN_NO_PARAMDOC       = NO
       
    88 WARN_FORMAT            = "$file:$line: $text"
       
    89 WARN_LOGFILE           = 
       
    90 #---------------------------------------------------------------------------
       
    91 # configuration options related to the input files
       
    92 #---------------------------------------------------------------------------
       
    93 INPUT                  = smf example
       
    94 INPUT_ENCODING         = UTF-8
       
    95 FILE_PATTERNS          = *.c \
       
    96                          *.cc \
       
    97                          *.cxx \
       
    98                          *.cpp \
       
    99                          *.c++ \
       
   100                          *.d \
       
   101                          *.java \
       
   102                          *.ii \
       
   103                          *.ixx \
       
   104                          *.ipp \
       
   105                          *.i++ \
       
   106                          *.inl \
       
   107                          *.h \
       
   108                          *.hh \
       
   109                          *.hxx \
       
   110                          *.hpp \
       
   111                          *.h++ \
       
   112                          *.idl \
       
   113                          *.odl \
       
   114                          *.cs \
       
   115                          *.php \
       
   116                          *.php3 \
       
   117                          *.inc \
       
   118                          *.m \
       
   119                          *.mm \
       
   120                          *.dox \
       
   121                          *.py \
       
   122                          *.f90 \
       
   123                          *.f \
       
   124                          *.vhd \
       
   125                          *.vhdl
       
   126 RECURSIVE              = YES
       
   127 EXCLUDE                = 
       
   128 EXCLUDE_SYMLINKS       = NO
       
   129 EXCLUDE_PATTERNS       = 
       
   130 EXCLUDE_SYMBOLS        = 
       
   131 EXAMPLE_PATH           = 
       
   132 EXAMPLE_PATTERNS       = *
       
   133 EXAMPLE_RECURSIVE      = NO
       
   134 IMAGE_PATH             = 
       
   135 INPUT_FILTER           = 
       
   136 FILTER_PATTERNS        = 
       
   137 FILTER_SOURCE_FILES    = NO
       
   138 #---------------------------------------------------------------------------
       
   139 # configuration options related to source browsing
       
   140 #---------------------------------------------------------------------------
       
   141 SOURCE_BROWSER         = YES
       
   142 INLINE_SOURCES         = YES
       
   143 STRIP_CODE_COMMENTS    = YES
       
   144 REFERENCED_BY_RELATION = YES
       
   145 REFERENCES_RELATION    = YES
       
   146 REFERENCES_LINK_SOURCE = YES
       
   147 USE_HTAGS              = YES
       
   148 VERBATIM_HEADERS       = YES
       
   149 #---------------------------------------------------------------------------
       
   150 # configuration options related to the alphabetical class index
       
   151 #---------------------------------------------------------------------------
       
   152 ALPHABETICAL_INDEX     = NO
       
   153 COLS_IN_ALPHA_INDEX    = 5
       
   154 IGNORE_PREFIX          = 
       
   155 #---------------------------------------------------------------------------
       
   156 # configuration options related to the HTML output
       
   157 #---------------------------------------------------------------------------
       
   158 GENERATE_HTML          = YES
       
   159 HTML_OUTPUT            = html
       
   160 HTML_FILE_EXTENSION    = .html
       
   161 HTML_HEADER            = 
       
   162 HTML_FOOTER            = 
       
   163 HTML_STYLESHEET        = 
       
   164 HTML_ALIGN_MEMBERS     = YES
       
   165 GENERATE_HTMLHELP      = NO
       
   166 GENERATE_DOCSET        = NO
       
   167 DOCSET_FEEDNAME        = "Doxygen generated docs"
       
   168 DOCSET_BUNDLE_ID       = org.doxygen.Project
       
   169 HTML_DYNAMIC_SECTIONS  = NO
       
   170 CHM_FILE               = 
       
   171 HHC_LOCATION           = 
       
   172 GENERATE_CHI           = NO
       
   173 BINARY_TOC             = NO
       
   174 TOC_EXPAND             = NO
       
   175 DISABLE_INDEX          = NO
       
   176 ENUM_VALUES_PER_LINE   = 4
       
   177 GENERATE_TREEVIEW      = NO
       
   178 TREEVIEW_WIDTH         = 250
       
   179 #---------------------------------------------------------------------------
       
   180 # configuration options related to the LaTeX output
       
   181 #---------------------------------------------------------------------------
       
   182 GENERATE_LATEX         = NO
       
   183 LATEX_OUTPUT           = latex
       
   184 LATEX_CMD_NAME         = latex
       
   185 MAKEINDEX_CMD_NAME     = makeindex
       
   186 COMPACT_LATEX          = NO
       
   187 PAPER_TYPE             = a4wide
       
   188 EXTRA_PACKAGES         = 
       
   189 LATEX_HEADER           = 
       
   190 PDF_HYPERLINKS         = YES
       
   191 USE_PDFLATEX           = YES
       
   192 LATEX_BATCHMODE        = NO
       
   193 LATEX_HIDE_INDICES     = NO
       
   194 #---------------------------------------------------------------------------
       
   195 # configuration options related to the RTF output
       
   196 #---------------------------------------------------------------------------
       
   197 GENERATE_RTF           = NO
       
   198 RTF_OUTPUT             = rtf
       
   199 COMPACT_RTF            = NO
       
   200 RTF_HYPERLINKS         = NO
       
   201 RTF_STYLESHEET_FILE    = 
       
   202 RTF_EXTENSIONS_FILE    = 
       
   203 #---------------------------------------------------------------------------
       
   204 # configuration options related to the man page output
       
   205 #---------------------------------------------------------------------------
       
   206 GENERATE_MAN           = NO
       
   207 MAN_OUTPUT             = man
       
   208 MAN_EXTENSION          = .3
       
   209 MAN_LINKS              = NO
       
   210 #---------------------------------------------------------------------------
       
   211 # configuration options related to the XML output
       
   212 #---------------------------------------------------------------------------
       
   213 GENERATE_XML           = NO
       
   214 XML_OUTPUT             = xml
       
   215 XML_SCHEMA             = 
       
   216 XML_DTD                = 
       
   217 XML_PROGRAMLISTING     = YES
       
   218 #---------------------------------------------------------------------------
       
   219 # configuration options for the AutoGen Definitions output
       
   220 #---------------------------------------------------------------------------
       
   221 GENERATE_AUTOGEN_DEF   = NO
       
   222 #---------------------------------------------------------------------------
       
   223 # configuration options related to the Perl module output
       
   224 #---------------------------------------------------------------------------
       
   225 GENERATE_PERLMOD       = NO
       
   226 PERLMOD_LATEX          = NO
       
   227 PERLMOD_PRETTY         = YES
       
   228 PERLMOD_MAKEVAR_PREFIX = 
       
   229 #---------------------------------------------------------------------------
       
   230 # Configuration options related to the preprocessor   
       
   231 #---------------------------------------------------------------------------
       
   232 ENABLE_PREPROCESSING   = YES
       
   233 MACRO_EXPANSION        = NO
       
   234 EXPAND_ONLY_PREDEF     = NO
       
   235 SEARCH_INCLUDES        = YES
       
   236 INCLUDE_PATH           = 
       
   237 INCLUDE_FILE_PATTERNS  = 
       
   238 PREDEFINED             = 
       
   239 EXPAND_AS_DEFINED      = 
       
   240 SKIP_FUNCTION_MACROS   = YES
       
   241 #---------------------------------------------------------------------------
       
   242 # Configuration::additions related to external references   
       
   243 #---------------------------------------------------------------------------
       
   244 TAGFILES               = 
       
   245 GENERATE_TAGFILE       = 
       
   246 ALLEXTERNALS           = NO
       
   247 EXTERNAL_GROUPS        = YES
       
   248 PERL_PATH              = /usr/bin/perl
       
   249 #---------------------------------------------------------------------------
       
   250 # Configuration options related to the dot tool   
       
   251 #---------------------------------------------------------------------------
       
   252 CLASS_DIAGRAMS         = NO
       
   253 MSCGEN_PATH            = 
       
   254 HIDE_UNDOC_RELATIONS   = YES
       
   255 HAVE_DOT               = YES
       
   256 CLASS_GRAPH            = YES
       
   257 COLLABORATION_GRAPH    = YES
       
   258 GROUP_GRAPHS           = YES
       
   259 UML_LOOK               = NO
       
   260 TEMPLATE_RELATIONS     = NO
       
   261 INCLUDE_GRAPH          = YES
       
   262 INCLUDED_BY_GRAPH      = YES
       
   263 CALL_GRAPH             = YES
       
   264 CALLER_GRAPH           = NO
       
   265 GRAPHICAL_HIERARCHY    = YES
       
   266 DIRECTORY_GRAPH        = YES
       
   267 DOT_IMAGE_FORMAT       = png
       
   268 DOT_PATH               = 
       
   269 DOTFILE_DIRS           = 
       
   270 DOT_GRAPH_MAX_NODES    = 50
       
   271 MAX_DOT_GRAPH_DEPTH    = 1000
       
   272 DOT_TRANSPARENT        = YES
       
   273 DOT_MULTI_TARGETS      = NO
       
   274 GENERATE_LEGEND        = YES
       
   275 DOT_CLEANUP            = YES
       
   276 #---------------------------------------------------------------------------
       
   277 # Configuration::additions related to the search engine   
       
   278 #---------------------------------------------------------------------------
       
   279 SEARCHENGINE           = NO