resource/docs/devdocs.doxyfile

   1 # Doxyfile 1.8.8
   2
   3 #---------------------------------------------------------------------------
   4 # Project related configuration options
   5 #---------------------------------------------------------------------------
   6 DOXYFILE_ENCODING      = UTF-8
   7 PROJECT_NAME           = "IoTivity Internals Documentation"
   8 PROJECT_NUMBER         =
   9 PROJECT_BRIEF          =
  10 PROJECT_LOGO           =
  11 OUTPUT_DIRECTORY       = devdocs
  12 CREATE_SUBDIRS         = NO
  13 ALLOW_UNICODE_NAMES    = NO
  14 OUTPUT_LANGUAGE        = English
  15 BRIEF_MEMBER_DESC      = YES
  16 REPEAT_BRIEF           = YES
  17 ABBREVIATE_BRIEF       =
  18 ALWAYS_DETAILED_SEC    = NO
  19 INLINE_INHERITED_MEMB  = NO
  20 FULL_PATH_NAMES        = NO
  21 STRIP_FROM_PATH        =
  22 STRIP_FROM_INC_PATH    =
  23 SHORT_NAMES            = NO
  24 JAVADOC_AUTOBRIEF      = YES
  25 QT_AUTOBRIEF           = NO
  26 MULTILINE_CPP_IS_BRIEF = NO
  27 INHERIT_DOCS           = YES
  28 SEPARATE_MEMBER_PAGES  = NO
  29 TAB_SIZE               = 4
  30 ALIASES                =
  31 TCL_SUBST              =
  32 OPTIMIZE_OUTPUT_FOR_C  = NO
  33 OPTIMIZE_OUTPUT_JAVA   = NO
  34 OPTIMIZE_FOR_FORTRAN   = NO
  35 OPTIMIZE_OUTPUT_VHDL   = NO
  36 EXTENSION_MAPPING      =
  37 MARKDOWN_SUPPORT       = YES
  38 AUTOLINK_SUPPORT       = YES
  39 BUILTIN_STL_SUPPORT    = NO
  40 CPP_CLI_SUPPORT        = NO
  41 SIP_SUPPORT            = NO
  42 IDL_PROPERTY_SUPPORT   = YES
  43 DISTRIBUTE_GROUP_DOC   = NO
  44 SUBGROUPING            = YES
  45 INLINE_GROUPED_CLASSES = NO
  46 INLINE_SIMPLE_STRUCTS  = NO
  47 TYPEDEF_HIDES_STRUCT   = NO
  48 LOOKUP_CACHE_SIZE      = 0
  49 #---------------------------------------------------------------------------
  50 # Build related configuration options
  51 #---------------------------------------------------------------------------
  52 EXTRACT_ALL            = YES
  53 EXTRACT_PRIVATE        = YES
  54 EXTRACT_PACKAGE        = YES
  55 EXTRACT_STATIC         = YES
  56 EXTRACT_LOCAL_CLASSES  = YES
  57 EXTRACT_LOCAL_METHODS  = NO
  58 EXTRACT_ANON_NSPACES   = NO
  59 HIDE_UNDOC_MEMBERS     = NO
  60 HIDE_UNDOC_CLASSES     = NO
  61 HIDE_FRIEND_COMPOUNDS  = NO
  62 HIDE_IN_BODY_DOCS      = NO
  63 INTERNAL_DOCS          = YES
  64 CASE_SENSE_NAMES       = YES
  65 HIDE_SCOPE_NAMES       = NO
  66 SHOW_INCLUDE_FILES     = YES
  67 SHOW_GROUPED_MEMB_INC  = NO
  68 FORCE_LOCAL_INCLUDES   = NO
  69 INLINE_INFO            = YES
  70 SORT_MEMBER_DOCS       = YES
  71 SORT_BRIEF_DOCS        = NO
  72 SORT_MEMBERS_CTORS_1ST = NO
  73 SORT_GROUP_NAMES       = NO
  74 SORT_BY_SCOPE_NAME     = NO
  75 STRICT_PROTO_MATCHING  = NO
  76 GENERATE_TODOLIST      = YES
  77 GENERATE_TESTLIST      = YES
  78 GENERATE_BUGLIST       = YES
  79 GENERATE_DEPRECATEDLIST= YES
  80 ENABLED_SECTIONS       =
  81 MAX_INITIALIZER_LINES  = 30
  82 SHOW_USED_FILES        = YES
  83 SHOW_FILES             = YES
  84 SHOW_NAMESPACES        = YES
  85 FILE_VERSION_FILTER    =
  86 LAYOUT_FILE            =
  87 CITE_BIB_FILES         =
  88 #---------------------------------------------------------------------------
  89 # Configuration options related to warning and progress messages
  90 #---------------------------------------------------------------------------
  91 QUIET                  = NO
  92 WARNINGS               = YES
  93 WARN_IF_UNDOCUMENTED   = YES
  94 WARN_IF_DOC_ERROR      = YES
  95 WARN_NO_PARAMDOC       = NO
  96 WARN_FORMAT            = "$file:$line: $text"
  97 WARN_LOGFILE           =
  98 #---------------------------------------------------------------------------
  99 # Configuration options related to the input files
 100 #---------------------------------------------------------------------------
 101 INPUT                  = devdox \
 102                          ../include \
 103                          ../src \
 104                          ../csdk/connectivity/api \
 105                          ../csdk/connectivity/common/inc \
 106                          ../csdk/connectivity/common/src \
 107                          ../csdk/connectivity/inc \
 108                          ../csdk/connectivity/src \
 109                          ../csdk/logger/include \
 110                          ../csdk/logger/src \
 111                          ../csdk/ocmalloc/include \
 112                          ../csdk/ocmalloc/src \
 113                          ../csdk/ocrandom/include \
 114                          ../csdk/ocrandom/src \
 115                          ../csdk/security/include \
 116                          ../csdk/security/src \
 117                          ../csdk/stack/include \
 118                          ../csdk/stack/src
 119
 120 INPUT_ENCODING         = UTF-8
 121 FILE_PATTERNS          =
 122 RECURSIVE              = YES
 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 FILTER_SOURCE_PATTERNS =
 135 USE_MDFILE_AS_MAINPAGE =
 136 #---------------------------------------------------------------------------
 137 # Configuration options related to source browsing
 138 #---------------------------------------------------------------------------
 139 SOURCE_BROWSER         = NO
 140 INLINE_SOURCES         = NO
 141 STRIP_CODE_COMMENTS    = YES
 142 REFERENCED_BY_RELATION = NO
 143 REFERENCES_RELATION    = NO
 144 REFERENCES_LINK_SOURCE = YES
 145 SOURCE_TOOLTIPS        = YES
 146 USE_HTAGS              = NO
 147 VERBATIM_HEADERS       = YES
 148 CLANG_ASSISTED_PARSING = NO
 149 CLANG_OPTIONS          =
 150 #---------------------------------------------------------------------------
 151 # Configuration options related to the alphabetical class index
 152 #---------------------------------------------------------------------------
 153 ALPHABETICAL_INDEX     = YES
 154 COLS_IN_ALPHA_INDEX    = 5
 155 IGNORE_PREFIX          =
 156 #---------------------------------------------------------------------------
 157 # Configuration options related to the HTML output
 158 #---------------------------------------------------------------------------
 159 GENERATE_HTML          = YES
 160 HTML_OUTPUT            = html
 161 HTML_FILE_EXTENSION    = .html
 162 HTML_HEADER            =
 163 HTML_FOOTER            =
 164 HTML_STYLESHEET        =
 165 HTML_EXTRA_STYLESHEET  =
 166 HTML_EXTRA_FILES       =
 167 HTML_COLORSTYLE_HUE    = 220
 168 HTML_COLORSTYLE_SAT    = 100
 169 HTML_COLORSTYLE_GAMMA  = 80
 170 HTML_TIMESTAMP         = YES
 171 HTML_DYNAMIC_SECTIONS  = NO
 172 HTML_INDEX_NUM_ENTRIES = 100
 173 GENERATE_DOCSET        = NO
 174 DOCSET_FEEDNAME        = "Doxygen generated docs"
 175 DOCSET_BUNDLE_ID       = org.doxygen.Project
 176 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
 177 DOCSET_PUBLISHER_NAME  = Publisher
 178 GENERATE_HTMLHELP      = NO
 179 CHM_FILE               =
 180 HHC_LOCATION           =
 181 GENERATE_CHI           = NO
 182 CHM_INDEX_ENCODING     =
 183 BINARY_TOC             = NO
 184 TOC_EXPAND             = NO
 185 GENERATE_QHP           = NO
 186 QCH_FILE               =
 187 QHP_NAMESPACE          = org.doxygen.Project
 188 QHP_VIRTUAL_FOLDER     = doc
 189 QHP_CUST_FILTER_NAME   =
 190 QHP_CUST_FILTER_ATTRS  =
 191 QHP_SECT_FILTER_ATTRS  =
 192 QHG_LOCATION           =
 193 GENERATE_ECLIPSEHELP   = NO
 194 ECLIPSE_DOC_ID         = org.doxygen.Project
 195 DISABLE_INDEX          = NO
 196 GENERATE_TREEVIEW      = NO
 197 ENUM_VALUES_PER_LINE   = 4
 198 TREEVIEW_WIDTH         = 250
 199 EXT_LINKS_IN_WINDOW    = NO
 200 FORMULA_FONTSIZE       = 10
 201 FORMULA_TRANSPARENT    = YES
 202 USE_MATHJAX            = NO
 203 MATHJAX_FORMAT         = HTML-CSS
 204 MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
 205 MATHJAX_EXTENSIONS     =
 206 MATHJAX_CODEFILE       =
 207 SEARCHENGINE           = YES
 208 SERVER_BASED_SEARCH    = NO
 209 EXTERNAL_SEARCH        = NO
 210 SEARCHENGINE_URL       =
 211 SEARCHDATA_FILE        = searchdata.xml
 212 EXTERNAL_SEARCH_ID     =
 213 EXTRA_SEARCH_MAPPINGS  =
 214 #---------------------------------------------------------------------------
 215 # Configuration options related to the LaTeX output
 216 #---------------------------------------------------------------------------
 217 GENERATE_LATEX         = YES
 218 LATEX_OUTPUT           = latex
 219 LATEX_CMD_NAME         = latex
 220 MAKEINDEX_CMD_NAME     = makeindex
 221 COMPACT_LATEX          = NO
 222 PAPER_TYPE             = a4
 223 EXTRA_PACKAGES         =
 224 LATEX_HEADER           =
 225 LATEX_FOOTER           =
 226 LATEX_EXTRA_FILES      =
 227 PDF_HYPERLINKS         = YES
 228 USE_PDFLATEX           = YES
 229 LATEX_BATCHMODE        = NO
 230 LATEX_HIDE_INDICES     = NO
 231 LATEX_SOURCE_CODE      = NO
 232 LATEX_BIB_STYLE        = plain
 233 #---------------------------------------------------------------------------
 234 # Configuration options related to the RTF output
 235 #---------------------------------------------------------------------------
 236 GENERATE_RTF           = NO
 237 RTF_OUTPUT             = rtf
 238 COMPACT_RTF            = NO
 239 RTF_HYPERLINKS         = NO
 240 RTF_STYLESHEET_FILE    =
 241 RTF_EXTENSIONS_FILE    =
 242 #---------------------------------------------------------------------------
 243 # Configuration options related to the man page output
 244 #---------------------------------------------------------------------------
 245 GENERATE_MAN           = NO
 246 MAN_OUTPUT             = man
 247 MAN_EXTENSION          = .3
 248 MAN_SUBDIR             =
 249 MAN_LINKS              = NO
 250 #---------------------------------------------------------------------------
 251 # Configuration options related to the XML output
 252 #---------------------------------------------------------------------------
 253 GENERATE_XML           = NO
 254 XML_OUTPUT             = xml
 255 XML_PROGRAMLISTING     = YES
 256 #---------------------------------------------------------------------------
 257 # Configuration options related to the DOCBOOK output
 258 #---------------------------------------------------------------------------
 259 GENERATE_DOCBOOK       = NO
 260 DOCBOOK_OUTPUT         = docbook
 261 DOCBOOK_PROGRAMLISTING = NO
 262 #---------------------------------------------------------------------------
 263 # Configuration options for the AutoGen Definitions output
 264 #---------------------------------------------------------------------------
 265 GENERATE_AUTOGEN_DEF   = NO
 266 #---------------------------------------------------------------------------
 267 # Configuration options related to the Perl module output
 268 #---------------------------------------------------------------------------
 269 GENERATE_PERLMOD       = NO
 270 PERLMOD_LATEX          = NO
 271 PERLMOD_PRETTY         = YES
 272 PERLMOD_MAKEVAR_PREFIX =
 273 #---------------------------------------------------------------------------
 274 # Configuration options related to the preprocessor
 275 #---------------------------------------------------------------------------
 276 ENABLE_PREPROCESSING   = YES
 277 MACRO_EXPANSION        = NO
 278 EXPAND_ONLY_PREDEF     = NO
 279 SEARCH_INCLUDES        = YES
 280 INCLUDE_PATH           =
 281 INCLUDE_FILE_PATTERNS  =
 282 PREDEFINED             =
 283 EXPAND_AS_DEFINED      =
 284 SKIP_FUNCTION_MACROS   = YES
 285 #---------------------------------------------------------------------------
 286 # Configuration options related to external references
 287 #---------------------------------------------------------------------------
 288 TAGFILES               =
 289 GENERATE_TAGFILE       =
 290 ALLEXTERNALS           = NO
 291 EXTERNAL_GROUPS        = YES
 292 EXTERNAL_PAGES         = YES
 293 PERL_PATH              = /usr/bin/perl
 294 #---------------------------------------------------------------------------
 295 # Configuration options related to the dot tool
 296 #---------------------------------------------------------------------------
 297 CLASS_DIAGRAMS         = YES
 298 MSCGEN_PATH            =
 299 DIA_PATH               =
 300 HIDE_UNDOC_RELATIONS   = YES
 301 HAVE_DOT               = YES
 302 DOT_NUM_THREADS        = 0
 303 DOT_FONTNAME           = Helvetica
 304 DOT_FONTSIZE           = 10
 305 DOT_FONTPATH           =
 306 CLASS_GRAPH            = YES
 307 COLLABORATION_GRAPH    = YES
 308 GROUP_GRAPHS           = YES
 309 UML_LOOK               = NO
 310 UML_LIMIT_NUM_FIELDS   = 10
 311 TEMPLATE_RELATIONS     = NO
 312 INCLUDE_GRAPH          = YES
 313 INCLUDED_BY_GRAPH      = YES
 314 CALL_GRAPH             = NO
 315 CALLER_GRAPH           = NO
 316 GRAPHICAL_HIERARCHY    = YES
 317 DIRECTORY_GRAPH        = YES
 318 DOT_IMAGE_FORMAT       = png
 319 INTERACTIVE_SVG        = NO
 320 DOT_PATH               =
 321 DOTFILE_DIRS           = devdox/dot
 322 MSCFILE_DIRS           =
 323 DIAFILE_DIRS           =
 324 PLANTUML_JAR_PATH      =
 325 DOT_GRAPH_MAX_NODES    = 50
 326 MAX_DOT_GRAPH_DEPTH    = 0
 327 DOT_TRANSPARENT        = NO
 328 DOT_MULTI_TARGETS      = NO
 329 GENERATE_LEGEND        = YES
 330 DOT_CLEANUP            = YES