resource/docs/c-doc/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/ocrandom/include \
 112                          ../csdk/ocrandom/src \
 113                          ../csdk/security/include \
 114                          ../csdk/security/src \
 115                          ../csdk/stack/include \
 116                          ../csdk/stack/src \
 117                          ../c_common/oic_malloc/include \
 118                          ../c_common/oic_malloc/src \
 119                          ../c_common/oic_string/include \
 120                          ../c_common/oic_string/src
 121
 122 INPUT_ENCODING         = UTF-8
 123 FILE_PATTERNS          =
 124 RECURSIVE              = YES
 125 EXCLUDE                =
 126 EXCLUDE_SYMLINKS       = NO
 127 EXCLUDE_PATTERNS       =
 128 EXCLUDE_SYMBOLS        =
 129 EXAMPLE_PATH           =
 130 EXAMPLE_PATTERNS       =
 131 EXAMPLE_RECURSIVE      = NO
 132 IMAGE_PATH             =
 133 INPUT_FILTER           =
 134 FILTER_PATTERNS        =
 135 FILTER_SOURCE_FILES    = NO
 136 FILTER_SOURCE_PATTERNS =
 137 USE_MDFILE_AS_MAINPAGE =
 138 #---------------------------------------------------------------------------
 139 # Configuration options related to source browsing
 140 #---------------------------------------------------------------------------
 141 SOURCE_BROWSER         = NO
 142 INLINE_SOURCES         = NO
 143 STRIP_CODE_COMMENTS    = YES
 144 REFERENCED_BY_RELATION = NO
 145 REFERENCES_RELATION    = NO
 146 REFERENCES_LINK_SOURCE = YES
 147 SOURCE_TOOLTIPS        = YES
 148 USE_HTAGS              = NO
 149 VERBATIM_HEADERS       = YES
 150 CLANG_ASSISTED_PARSING = NO
 151 CLANG_OPTIONS          =
 152 #---------------------------------------------------------------------------
 153 # Configuration options related to the alphabetical class index
 154 #---------------------------------------------------------------------------
 155 ALPHABETICAL_INDEX     = YES
 156 COLS_IN_ALPHA_INDEX    = 5
 157 IGNORE_PREFIX          =
 158 #---------------------------------------------------------------------------
 159 # Configuration options related to the HTML output
 160 #---------------------------------------------------------------------------
 161 GENERATE_HTML          = YES
 162 HTML_OUTPUT            = html
 163 HTML_FILE_EXTENSION    = .html
 164 HTML_HEADER            =
 165 HTML_FOOTER            =
 166 HTML_STYLESHEET        =
 167 HTML_EXTRA_STYLESHEET  =
 168 HTML_EXTRA_FILES       =
 169 HTML_COLORSTYLE_HUE    = 220
 170 HTML_COLORSTYLE_SAT    = 100
 171 HTML_COLORSTYLE_GAMMA  = 80
 172 HTML_TIMESTAMP         = YES
 173 HTML_DYNAMIC_SECTIONS  = NO
 174 HTML_INDEX_NUM_ENTRIES = 100
 175 GENERATE_DOCSET        = NO
 176 DOCSET_FEEDNAME        = "Doxygen generated docs"
 177 DOCSET_BUNDLE_ID       = org.doxygen.Project
 178 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
 179 DOCSET_PUBLISHER_NAME  = Publisher
 180 GENERATE_HTMLHELP      = NO
 181 CHM_FILE               =
 182 HHC_LOCATION           =
 183 GENERATE_CHI           = NO
 184 CHM_INDEX_ENCODING     =
 185 BINARY_TOC             = NO
 186 TOC_EXPAND             = NO
 187 GENERATE_QHP           = NO
 188 QCH_FILE               =
 189 QHP_NAMESPACE          = org.doxygen.Project
 190 QHP_VIRTUAL_FOLDER     = doc
 191 QHP_CUST_FILTER_NAME   =
 192 QHP_CUST_FILTER_ATTRS  =
 193 QHP_SECT_FILTER_ATTRS  =
 194 QHG_LOCATION           =
 195 GENERATE_ECLIPSEHELP   = NO
 196 ECLIPSE_DOC_ID         = org.doxygen.Project
 197 DISABLE_INDEX          = NO
 198 GENERATE_TREEVIEW      = NO
 199 ENUM_VALUES_PER_LINE   = 4
 200 TREEVIEW_WIDTH         = 250
 201 EXT_LINKS_IN_WINDOW    = NO
 202 FORMULA_FONTSIZE       = 10
 203 FORMULA_TRANSPARENT    = YES
 204 USE_MATHJAX            = NO
 205 MATHJAX_FORMAT         = HTML-CSS
 206 MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
 207 MATHJAX_EXTENSIONS     =
 208 MATHJAX_CODEFILE       =
 209 SEARCHENGINE           = YES
 210 SERVER_BASED_SEARCH    = NO
 211 EXTERNAL_SEARCH        = NO
 212 SEARCHENGINE_URL       =
 213 SEARCHDATA_FILE        = searchdata.xml
 214 EXTERNAL_SEARCH_ID     =
 215 EXTRA_SEARCH_MAPPINGS  =
 216 #---------------------------------------------------------------------------
 217 # Configuration options related to the LaTeX output
 218 #---------------------------------------------------------------------------
 219 GENERATE_LATEX         = YES
 220 LATEX_OUTPUT           = latex
 221 LATEX_CMD_NAME         = latex
 222 MAKEINDEX_CMD_NAME     = makeindex
 223 COMPACT_LATEX          = NO
 224 PAPER_TYPE             = a4
 225 EXTRA_PACKAGES         =
 226 LATEX_HEADER           =
 227 LATEX_FOOTER           =
 228 LATEX_EXTRA_FILES      =
 229 PDF_HYPERLINKS         = YES
 230 USE_PDFLATEX           = YES
 231 LATEX_BATCHMODE        = NO
 232 LATEX_HIDE_INDICES     = NO
 233 LATEX_SOURCE_CODE      = NO
 234 LATEX_BIB_STYLE        = plain
 235 #---------------------------------------------------------------------------
 236 # Configuration options related to the RTF output
 237 #---------------------------------------------------------------------------
 238 GENERATE_RTF           = NO
 239 RTF_OUTPUT             = rtf
 240 COMPACT_RTF            = NO
 241 RTF_HYPERLINKS         = NO
 242 RTF_STYLESHEET_FILE    =
 243 RTF_EXTENSIONS_FILE    =
 244 #---------------------------------------------------------------------------
 245 # Configuration options related to the man page output
 246 #---------------------------------------------------------------------------
 247 GENERATE_MAN           = NO
 248 MAN_OUTPUT             = man
 249 MAN_EXTENSION          = .3
 250 MAN_SUBDIR             =
 251 MAN_LINKS              = NO
 252 #---------------------------------------------------------------------------
 253 # Configuration options related to the XML output
 254 #---------------------------------------------------------------------------
 255 GENERATE_XML           = NO
 256 XML_OUTPUT             = xml
 257 XML_PROGRAMLISTING     = YES
 258 #---------------------------------------------------------------------------
 259 # Configuration options related to the DOCBOOK output
 260 #---------------------------------------------------------------------------
 261 GENERATE_DOCBOOK       = NO
 262 DOCBOOK_OUTPUT         = docbook
 263 DOCBOOK_PROGRAMLISTING = NO
 264 #---------------------------------------------------------------------------
 265 # Configuration options for the AutoGen Definitions output
 266 #---------------------------------------------------------------------------
 267 GENERATE_AUTOGEN_DEF   = NO
 268 #---------------------------------------------------------------------------
 269 # Configuration options related to the Perl module output
 270 #---------------------------------------------------------------------------
 271 GENERATE_PERLMOD       = NO
 272 PERLMOD_LATEX          = NO
 273 PERLMOD_PRETTY         = YES
 274 PERLMOD_MAKEVAR_PREFIX =
 275 #---------------------------------------------------------------------------
 276 # Configuration options related to the preprocessor
 277 #---------------------------------------------------------------------------
 278 ENABLE_PREPROCESSING   = YES
 279 MACRO_EXPANSION        = NO
 280 EXPAND_ONLY_PREDEF     = NO
 281 SEARCH_INCLUDES        = YES
 282 INCLUDE_PATH           =
 283 INCLUDE_FILE_PATTERNS  =
 284 PREDEFINED             =
 285 EXPAND_AS_DEFINED      =
 286 SKIP_FUNCTION_MACROS   = YES
 287 #---------------------------------------------------------------------------
 288 # Configuration options related to external references
 289 #---------------------------------------------------------------------------
 290 TAGFILES               =
 291 GENERATE_TAGFILE       =
 292 ALLEXTERNALS           = NO
 293 EXTERNAL_GROUPS        = YES
 294 EXTERNAL_PAGES         = YES
 295 PERL_PATH              = /usr/bin/perl
 296 #---------------------------------------------------------------------------
 297 # Configuration options related to the dot tool
 298 #---------------------------------------------------------------------------
 299 CLASS_DIAGRAMS         = YES
 300 MSCGEN_PATH            =
 301 DIA_PATH               =
 302 HIDE_UNDOC_RELATIONS   = YES
 303 HAVE_DOT               = YES
 304 DOT_NUM_THREADS        = 0
 305 DOT_FONTNAME           = Helvetica
 306 DOT_FONTSIZE           = 10
 307 DOT_FONTPATH           =
 308 CLASS_GRAPH            = YES
 309 COLLABORATION_GRAPH    = YES
 310 GROUP_GRAPHS           = YES
 311 UML_LOOK               = NO
 312 UML_LIMIT_NUM_FIELDS   = 10
 313 TEMPLATE_RELATIONS     = NO
 314 INCLUDE_GRAPH          = YES
 315 INCLUDED_BY_GRAPH      = YES
 316 CALL_GRAPH             = NO
 317 CALLER_GRAPH           = NO
 318 GRAPHICAL_HIERARCHY    = YES
 319 DIRECTORY_GRAPH        = YES
 320 DOT_IMAGE_FORMAT       = png
 321 INTERACTIVE_SVG        = NO
 322 DOT_PATH               =
 323 DOTFILE_DIRS           = devdox/dot
 324 MSCFILE_DIRS           =
 325 DIAFILE_DIRS           =
 326 PLANTUML_JAR_PATH      =
 327 DOT_GRAPH_MAX_NODES    = 50
 328 MAX_DOT_GRAPH_DEPTH    = 0
 329 DOT_TRANSPARENT        = NO
 330 DOT_MULTI_TARGETS      = NO
 331 GENERATE_LEGEND        = YES
 332 DOT_CLEANUP            = YES