xref: /nrf52832-nimble/rt-thread/components/net/uip/doc/Doxyfile (revision 042d53a763ad75cb1465103098bb88c245d95138)
1# Doxyfile 1.4.6
2
3#---------------------------------------------------------------------------
4# Project related configuration options
5#---------------------------------------------------------------------------
6PROJECT_NAME           = "uIP 1.0"
7PROJECT_NUMBER         =
8OUTPUT_DIRECTORY       = .
9CREATE_SUBDIRS         = NO
10OUTPUT_LANGUAGE        = English
11USE_WINDOWS_ENCODING   = NO
12BRIEF_MEMBER_DESC      = YES
13REPEAT_BRIEF           = YES
14ABBREVIATE_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
25ALWAYS_DETAILED_SEC    = NO
26INLINE_INHERITED_MEMB  = NO
27FULL_PATH_NAMES        = YES
28STRIP_FROM_PATH        = ../ \
29                         ../../
30STRIP_FROM_INC_PATH    =
31SHORT_NAMES            = YES
32JAVADOC_AUTOBRIEF      = YES
33MULTILINE_CPP_IS_BRIEF = NO
34DETAILS_AT_TOP         = YES
35INHERIT_DOCS           = YES
36SEPARATE_MEMBER_PAGES  = NO
37TAB_SIZE               = 8
38ALIASES                =
39OPTIMIZE_OUTPUT_FOR_C  = YES
40OPTIMIZE_OUTPUT_JAVA   = NO
41BUILTIN_STL_SUPPORT    = NO
42DISTRIBUTE_GROUP_DOC   = NO
43SUBGROUPING            = YES
44#---------------------------------------------------------------------------
45# Build related configuration options
46#---------------------------------------------------------------------------
47EXTRACT_ALL            = NO
48EXTRACT_PRIVATE        = NO
49EXTRACT_STATIC         = NO
50EXTRACT_LOCAL_CLASSES  = NO
51EXTRACT_LOCAL_METHODS  = NO
52HIDE_UNDOC_MEMBERS     = YES
53HIDE_UNDOC_CLASSES     = YES
54HIDE_FRIEND_COMPOUNDS  = NO
55HIDE_IN_BODY_DOCS      = NO
56INTERNAL_DOCS          = NO
57CASE_SENSE_NAMES       = YES
58HIDE_SCOPE_NAMES       = NO
59SHOW_INCLUDE_FILES     = YES
60INLINE_INFO            = YES
61SORT_MEMBER_DOCS       = YES
62SORT_BRIEF_DOCS        = NO
63SORT_BY_SCOPE_NAME     = NO
64GENERATE_TODOLIST      = YES
65GENERATE_TESTLIST      = YES
66GENERATE_BUGLIST       = NO
67GENERATE_DEPRECATEDLIST= NO
68ENABLED_SECTIONS       =
69MAX_INITIALIZER_LINES  = 30
70SHOW_USED_FILES        = NO
71SHOW_DIRECTORIES       = NO
72FILE_VERSION_FILTER    =
73#---------------------------------------------------------------------------
74# configuration options related to warning and progress messages
75#---------------------------------------------------------------------------
76QUIET                  = NO
77WARNINGS               = YES
78WARN_IF_UNDOCUMENTED   = YES
79WARN_IF_DOC_ERROR      = YES
80WARN_NO_PARAMDOC       = NO
81WARN_FORMAT            = "$file:$line: $text"
82WARN_LOGFILE           =
83#---------------------------------------------------------------------------
84# configuration options related to the input files
85#---------------------------------------------------------------------------
86INPUT                  = uip-doc.txt \
87                         pt-doc.txt \
88                         examples.txt \
89                         uip-code-style.txt \
90                         ../uip/uip.h \
91                         ../uip/uip.c \
92                         ../uip/uip_arch.h \
93                         ../uip/uip_arp.h \
94                         ../uip/uip_arp.c \
95                         ../unix/uip-conf.h \
96                         ../uip/uipopt.h \
97                         ../uip/uip-split.h \
98                         ../uip/uip-split.c \
99                         ../uip/uip-neighbor.h \
100                         ../uip/uip-neighbor.c \
101                         ../uip/pt.h \
102                         ../uip/lc.h \
103                         ../uip/lc-switch.h \
104                         ../uip/lc-addrlabels.h \
105                         ../uip/timer.h \
106                         ../uip/timer.c \
107                         ../uip/clock.h \
108                         ../uip/psock.h \
109                         ../uip/psock.c \
110                         ../lib/memb.c \
111                         ../lib/memb.h \
112                         ../apps/resolv/resolv.h \
113                         ../apps/resolv/resolv.c \
114                         ../apps/dhcpc/dhcpc.h \
115                         ../apps/dhcpc/dhcpc.c \
116                         ../apps/smtp/smtp.h \
117                         ../apps/smtp/smtp.c \
118                         ../apps/telnetd/telnetd.h \
119                         ../apps/telnetd/telnetd.c \
120                         ../apps/telnetd/shell.h \
121                         ../apps/telnetd/shell.c \
122                         ../apps/hello-world/hello-world.h \
123                         ../apps/hello-world/hello-world.c \
124                         ../apps/webclient/webclient.h \
125                         ../apps/webclient/webclient.c \
126                         ../apps/webserver/httpd.h \
127                         ../apps/webserver/httpd-cgi.h \
128                         ../apps/webserver/httpd-cgi.c \
129                         ../apps/webserver/httpd.c
130FILE_PATTERNS          =
131RECURSIVE              = NO
132EXCLUDE                =
133EXCLUDE_SYMLINKS       = NO
134EXCLUDE_PATTERNS       =
135EXAMPLE_PATH           = . ../apps/hello-world ../apps/smtp \
136                         ../apps/telnetd ../apps/resolv ../apps/webclient \
137			 ../apps/webserver ../unix ../apps/dhcpc
138EXAMPLE_PATTERNS       =
139EXAMPLE_RECURSIVE      = NO
140IMAGE_PATH             =
141INPUT_FILTER           =
142FILTER_PATTERNS        =
143FILTER_SOURCE_FILES    = NO
144#---------------------------------------------------------------------------
145# configuration options related to source browsing
146#---------------------------------------------------------------------------
147SOURCE_BROWSER         = YES
148INLINE_SOURCES         = NO
149STRIP_CODE_COMMENTS    = NO
150REFERENCED_BY_RELATION = YES
151REFERENCES_RELATION    = YES
152USE_HTAGS              = NO
153VERBATIM_HEADERS       = NO
154#---------------------------------------------------------------------------
155# configuration options related to the alphabetical class index
156#---------------------------------------------------------------------------
157ALPHABETICAL_INDEX     = YES
158COLS_IN_ALPHA_INDEX    = 5
159IGNORE_PREFIX          =
160#---------------------------------------------------------------------------
161# configuration options related to the HTML output
162#---------------------------------------------------------------------------
163GENERATE_HTML          = YES
164HTML_OUTPUT            = html
165HTML_FILE_EXTENSION    = .html
166HTML_HEADER            =
167HTML_FOOTER            =
168HTML_STYLESHEET        =
169HTML_ALIGN_MEMBERS     = YES
170GENERATE_HTMLHELP      = YES
171CHM_FILE               =
172HHC_LOCATION           =
173GENERATE_CHI           = YES
174BINARY_TOC             = YES
175TOC_EXPAND             = NO
176DISABLE_INDEX          = NO
177ENUM_VALUES_PER_LINE   = 4
178GENERATE_TREEVIEW      = YES
179TREEVIEW_WIDTH         = 250
180#---------------------------------------------------------------------------
181# configuration options related to the LaTeX output
182#---------------------------------------------------------------------------
183GENERATE_LATEX         = YES
184LATEX_OUTPUT           = latex
185LATEX_CMD_NAME         = latex
186MAKEINDEX_CMD_NAME     = makeindex
187COMPACT_LATEX          = NO
188PAPER_TYPE             = a4wide
189EXTRA_PACKAGES         =
190LATEX_HEADER           = header.tex
191PDF_HYPERLINKS         = YES
192USE_PDFLATEX           = YES
193LATEX_BATCHMODE        = NO
194LATEX_HIDE_INDICES     = NO
195#---------------------------------------------------------------------------
196# configuration options related to the RTF output
197#---------------------------------------------------------------------------
198GENERATE_RTF           = NO
199RTF_OUTPUT             = rtf
200COMPACT_RTF            = NO
201RTF_HYPERLINKS         = NO
202RTF_STYLESHEET_FILE    =
203RTF_EXTENSIONS_FILE    =
204#---------------------------------------------------------------------------
205# configuration options related to the man page output
206#---------------------------------------------------------------------------
207GENERATE_MAN           = NO
208MAN_OUTPUT             = man
209MAN_EXTENSION          = .3
210MAN_LINKS              = NO
211#---------------------------------------------------------------------------
212# configuration options related to the XML output
213#---------------------------------------------------------------------------
214GENERATE_XML           = NO
215XML_OUTPUT             = xml
216XML_SCHEMA             =
217XML_DTD                =
218XML_PROGRAMLISTING     = YES
219#---------------------------------------------------------------------------
220# configuration options for the AutoGen Definitions output
221#---------------------------------------------------------------------------
222GENERATE_AUTOGEN_DEF   = NO
223#---------------------------------------------------------------------------
224# configuration options related to the Perl module output
225#---------------------------------------------------------------------------
226GENERATE_PERLMOD       = NO
227PERLMOD_LATEX          = NO
228PERLMOD_PRETTY         = YES
229PERLMOD_MAKEVAR_PREFIX =
230#---------------------------------------------------------------------------
231# Configuration options related to the preprocessor
232#---------------------------------------------------------------------------
233ENABLE_PREPROCESSING   = YES
234MACRO_EXPANSION        = NO
235EXPAND_ONLY_PREDEF     = NO
236SEARCH_INCLUDES        = YES
237INCLUDE_PATH           =
238INCLUDE_FILE_PATTERNS  =
239PREDEFINED             = UIP_UDP
240EXPAND_AS_DEFINED      =
241SKIP_FUNCTION_MACROS   = YES
242#---------------------------------------------------------------------------
243# Configuration::additions related to external references
244#---------------------------------------------------------------------------
245TAGFILES               =
246GENERATE_TAGFILE       =
247ALLEXTERNALS           = NO
248EXTERNAL_GROUPS        = YES
249PERL_PATH              = /usr/bin/perl
250#---------------------------------------------------------------------------
251# Configuration options related to the dot tool
252#---------------------------------------------------------------------------
253CLASS_DIAGRAMS         = NO
254HIDE_UNDOC_RELATIONS   = NO
255HAVE_DOT               = NO
256CLASS_GRAPH            = NO
257COLLABORATION_GRAPH    = NO
258GROUP_GRAPHS           = NO
259UML_LOOK               = NO
260TEMPLATE_RELATIONS     = NO
261INCLUDE_GRAPH          = NO
262INCLUDED_BY_GRAPH      = NO
263CALL_GRAPH             = NO
264GRAPHICAL_HIERARCHY    = NO
265DIRECTORY_GRAPH        = NO
266DOT_IMAGE_FORMAT       = png
267DOT_PATH               =
268DOTFILE_DIRS           =
269MAX_DOT_GRAPH_WIDTH    = 1024
270MAX_DOT_GRAPH_HEIGHT   = 1024
271MAX_DOT_GRAPH_DEPTH    = 0
272DOT_TRANSPARENT        = NO
273DOT_MULTI_TARGETS      = NO
274GENERATE_LEGEND        = YES
275DOT_CLEANUP            = YES
276#---------------------------------------------------------------------------
277# Configuration::additions related to the search engine
278#---------------------------------------------------------------------------
279SEARCHENGINE           = NO
280