Doxyfile 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279
  1. # Doxyfile 1.4.6
  2. #---------------------------------------------------------------------------
  3. # Project related configuration options
  4. #---------------------------------------------------------------------------
  5. PROJECT_NAME = "uIP 1.0"
  6. PROJECT_NUMBER =
  7. OUTPUT_DIRECTORY = .
  8. CREATE_SUBDIRS = NO
  9. OUTPUT_LANGUAGE = English
  10. USE_WINDOWS_ENCODING = NO
  11. BRIEF_MEMBER_DESC = YES
  12. REPEAT_BRIEF = YES
  13. ABBREVIATE_BRIEF = "The $name class" \
  14. "The $name widget" \
  15. "The $name file" \
  16. is \
  17. provides \
  18. specifies \
  19. contains \
  20. represents \
  21. a \
  22. an \
  23. the
  24. ALWAYS_DETAILED_SEC = NO
  25. INLINE_INHERITED_MEMB = NO
  26. FULL_PATH_NAMES = YES
  27. STRIP_FROM_PATH = ../ \
  28. ../../
  29. STRIP_FROM_INC_PATH =
  30. SHORT_NAMES = YES
  31. JAVADOC_AUTOBRIEF = YES
  32. MULTILINE_CPP_IS_BRIEF = NO
  33. DETAILS_AT_TOP = YES
  34. INHERIT_DOCS = YES
  35. SEPARATE_MEMBER_PAGES = NO
  36. TAB_SIZE = 8
  37. ALIASES =
  38. OPTIMIZE_OUTPUT_FOR_C = YES
  39. OPTIMIZE_OUTPUT_JAVA = NO
  40. BUILTIN_STL_SUPPORT = NO
  41. DISTRIBUTE_GROUP_DOC = NO
  42. SUBGROUPING = YES
  43. #---------------------------------------------------------------------------
  44. # Build related configuration options
  45. #---------------------------------------------------------------------------
  46. EXTRACT_ALL = NO
  47. EXTRACT_PRIVATE = NO
  48. EXTRACT_STATIC = NO
  49. EXTRACT_LOCAL_CLASSES = NO
  50. EXTRACT_LOCAL_METHODS = NO
  51. HIDE_UNDOC_MEMBERS = YES
  52. HIDE_UNDOC_CLASSES = YES
  53. HIDE_FRIEND_COMPOUNDS = NO
  54. HIDE_IN_BODY_DOCS = NO
  55. INTERNAL_DOCS = NO
  56. CASE_SENSE_NAMES = YES
  57. HIDE_SCOPE_NAMES = NO
  58. SHOW_INCLUDE_FILES = YES
  59. INLINE_INFO = YES
  60. SORT_MEMBER_DOCS = YES
  61. SORT_BRIEF_DOCS = NO
  62. SORT_BY_SCOPE_NAME = NO
  63. GENERATE_TODOLIST = YES
  64. GENERATE_TESTLIST = YES
  65. GENERATE_BUGLIST = NO
  66. GENERATE_DEPRECATEDLIST= NO
  67. ENABLED_SECTIONS =
  68. MAX_INITIALIZER_LINES = 30
  69. SHOW_USED_FILES = NO
  70. SHOW_DIRECTORIES = NO
  71. FILE_VERSION_FILTER =
  72. #---------------------------------------------------------------------------
  73. # configuration options related to warning and progress messages
  74. #---------------------------------------------------------------------------
  75. QUIET = NO
  76. WARNINGS = YES
  77. WARN_IF_UNDOCUMENTED = YES
  78. WARN_IF_DOC_ERROR = YES
  79. WARN_NO_PARAMDOC = NO
  80. WARN_FORMAT = "$file:$line: $text"
  81. WARN_LOGFILE =
  82. #---------------------------------------------------------------------------
  83. # configuration options related to the input files
  84. #---------------------------------------------------------------------------
  85. INPUT = uip-doc.txt \
  86. pt-doc.txt \
  87. examples.txt \
  88. uip-code-style.txt \
  89. ../uip/uip.h \
  90. ../uip/uip.c \
  91. ../uip/uip_arch.h \
  92. ../uip/uip_arp.h \
  93. ../uip/uip_arp.c \
  94. ../unix/uip-conf.h \
  95. ../uip/uipopt.h \
  96. ../uip/uip-split.h \
  97. ../uip/uip-split.c \
  98. ../uip/uip-neighbor.h \
  99. ../uip/uip-neighbor.c \
  100. ../uip/pt.h \
  101. ../uip/lc.h \
  102. ../uip/lc-switch.h \
  103. ../uip/lc-addrlabels.h \
  104. ../uip/timer.h \
  105. ../uip/timer.c \
  106. ../uip/clock.h \
  107. ../uip/psock.h \
  108. ../uip/psock.c \
  109. ../lib/memb.c \
  110. ../lib/memb.h \
  111. ../apps/resolv/resolv.h \
  112. ../apps/resolv/resolv.c \
  113. ../apps/dhcpc/dhcpc.h \
  114. ../apps/dhcpc/dhcpc.c \
  115. ../apps/smtp/smtp.h \
  116. ../apps/smtp/smtp.c \
  117. ../apps/telnetd/telnetd.h \
  118. ../apps/telnetd/telnetd.c \
  119. ../apps/telnetd/shell.h \
  120. ../apps/telnetd/shell.c \
  121. ../apps/hello-world/hello-world.h \
  122. ../apps/hello-world/hello-world.c \
  123. ../apps/webclient/webclient.h \
  124. ../apps/webclient/webclient.c \
  125. ../apps/webserver/httpd.h \
  126. ../apps/webserver/httpd-cgi.h \
  127. ../apps/webserver/httpd-cgi.c \
  128. ../apps/webserver/httpd.c
  129. FILE_PATTERNS =
  130. RECURSIVE = NO
  131. EXCLUDE =
  132. EXCLUDE_SYMLINKS = NO
  133. EXCLUDE_PATTERNS =
  134. EXAMPLE_PATH = . ../apps/hello-world ../apps/smtp \
  135. ../apps/telnetd ../apps/resolv ../apps/webclient \
  136. ../apps/webserver ../unix ../apps/dhcpc
  137. EXAMPLE_PATTERNS =
  138. EXAMPLE_RECURSIVE = NO
  139. IMAGE_PATH =
  140. INPUT_FILTER =
  141. FILTER_PATTERNS =
  142. FILTER_SOURCE_FILES = NO
  143. #---------------------------------------------------------------------------
  144. # configuration options related to source browsing
  145. #---------------------------------------------------------------------------
  146. SOURCE_BROWSER = YES
  147. INLINE_SOURCES = NO
  148. STRIP_CODE_COMMENTS = NO
  149. REFERENCED_BY_RELATION = YES
  150. REFERENCES_RELATION = YES
  151. USE_HTAGS = NO
  152. VERBATIM_HEADERS = NO
  153. #---------------------------------------------------------------------------
  154. # configuration options related to the alphabetical class index
  155. #---------------------------------------------------------------------------
  156. ALPHABETICAL_INDEX = YES
  157. COLS_IN_ALPHA_INDEX = 5
  158. IGNORE_PREFIX =
  159. #---------------------------------------------------------------------------
  160. # configuration options related to the HTML output
  161. #---------------------------------------------------------------------------
  162. GENERATE_HTML = YES
  163. HTML_OUTPUT = html
  164. HTML_FILE_EXTENSION = .html
  165. HTML_HEADER =
  166. HTML_FOOTER =
  167. HTML_STYLESHEET =
  168. HTML_ALIGN_MEMBERS = YES
  169. GENERATE_HTMLHELP = YES
  170. CHM_FILE =
  171. HHC_LOCATION =
  172. GENERATE_CHI = YES
  173. BINARY_TOC = YES
  174. TOC_EXPAND = NO
  175. DISABLE_INDEX = NO
  176. ENUM_VALUES_PER_LINE = 4
  177. GENERATE_TREEVIEW = YES
  178. TREEVIEW_WIDTH = 250
  179. #---------------------------------------------------------------------------
  180. # configuration options related to the LaTeX output
  181. #---------------------------------------------------------------------------
  182. GENERATE_LATEX = YES
  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 = header.tex
  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 = UIP_UDP
  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. HIDE_UNDOC_RELATIONS = NO
  254. HAVE_DOT = NO
  255. CLASS_GRAPH = NO
  256. COLLABORATION_GRAPH = NO
  257. GROUP_GRAPHS = NO
  258. UML_LOOK = NO
  259. TEMPLATE_RELATIONS = NO
  260. INCLUDE_GRAPH = NO
  261. INCLUDED_BY_GRAPH = NO
  262. CALL_GRAPH = NO
  263. GRAPHICAL_HIERARCHY = NO
  264. DIRECTORY_GRAPH = NO
  265. DOT_IMAGE_FORMAT = png
  266. DOT_PATH =
  267. DOTFILE_DIRS =
  268. MAX_DOT_GRAPH_WIDTH = 1024
  269. MAX_DOT_GRAPH_HEIGHT = 1024
  270. MAX_DOT_GRAPH_DEPTH = 0
  271. DOT_TRANSPARENT = NO
  272. DOT_MULTI_TARGETS = NO
  273. GENERATE_LEGEND = YES
  274. DOT_CLEANUP = YES
  275. #---------------------------------------------------------------------------
  276. # Configuration::additions related to the search engine
  277. #---------------------------------------------------------------------------
  278. SEARCHENGINE = NO