doc/Doxyfile

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