xref: /nrf52832-nimble/rt-thread/components/net/uip/doc/Doxyfile (revision 104654410c56c573564690304ae786df310c91fc)
1*10465441SEvalZero# Doxyfile 1.4.6
2*10465441SEvalZero
3*10465441SEvalZero#---------------------------------------------------------------------------
4*10465441SEvalZero# Project related configuration options
5*10465441SEvalZero#---------------------------------------------------------------------------
6*10465441SEvalZeroPROJECT_NAME           = "uIP 1.0"
7*10465441SEvalZeroPROJECT_NUMBER         =
8*10465441SEvalZeroOUTPUT_DIRECTORY       = .
9*10465441SEvalZeroCREATE_SUBDIRS         = NO
10*10465441SEvalZeroOUTPUT_LANGUAGE        = English
11*10465441SEvalZeroUSE_WINDOWS_ENCODING   = NO
12*10465441SEvalZeroBRIEF_MEMBER_DESC      = YES
13*10465441SEvalZeroREPEAT_BRIEF           = YES
14*10465441SEvalZeroABBREVIATE_BRIEF       = "The $name class" \
15*10465441SEvalZero                         "The $name widget" \
16*10465441SEvalZero                         "The $name file" \
17*10465441SEvalZero                         is \
18*10465441SEvalZero                         provides \
19*10465441SEvalZero                         specifies \
20*10465441SEvalZero                         contains \
21*10465441SEvalZero                         represents \
22*10465441SEvalZero                         a \
23*10465441SEvalZero                         an \
24*10465441SEvalZero                         the
25*10465441SEvalZeroALWAYS_DETAILED_SEC    = NO
26*10465441SEvalZeroINLINE_INHERITED_MEMB  = NO
27*10465441SEvalZeroFULL_PATH_NAMES        = YES
28*10465441SEvalZeroSTRIP_FROM_PATH        = ../ \
29*10465441SEvalZero                         ../../
30*10465441SEvalZeroSTRIP_FROM_INC_PATH    =
31*10465441SEvalZeroSHORT_NAMES            = YES
32*10465441SEvalZeroJAVADOC_AUTOBRIEF      = YES
33*10465441SEvalZeroMULTILINE_CPP_IS_BRIEF = NO
34*10465441SEvalZeroDETAILS_AT_TOP         = YES
35*10465441SEvalZeroINHERIT_DOCS           = YES
36*10465441SEvalZeroSEPARATE_MEMBER_PAGES  = NO
37*10465441SEvalZeroTAB_SIZE               = 8
38*10465441SEvalZeroALIASES                =
39*10465441SEvalZeroOPTIMIZE_OUTPUT_FOR_C  = YES
40*10465441SEvalZeroOPTIMIZE_OUTPUT_JAVA   = NO
41*10465441SEvalZeroBUILTIN_STL_SUPPORT    = NO
42*10465441SEvalZeroDISTRIBUTE_GROUP_DOC   = NO
43*10465441SEvalZeroSUBGROUPING            = YES
44*10465441SEvalZero#---------------------------------------------------------------------------
45*10465441SEvalZero# Build related configuration options
46*10465441SEvalZero#---------------------------------------------------------------------------
47*10465441SEvalZeroEXTRACT_ALL            = NO
48*10465441SEvalZeroEXTRACT_PRIVATE        = NO
49*10465441SEvalZeroEXTRACT_STATIC         = NO
50*10465441SEvalZeroEXTRACT_LOCAL_CLASSES  = NO
51*10465441SEvalZeroEXTRACT_LOCAL_METHODS  = NO
52*10465441SEvalZeroHIDE_UNDOC_MEMBERS     = YES
53*10465441SEvalZeroHIDE_UNDOC_CLASSES     = YES
54*10465441SEvalZeroHIDE_FRIEND_COMPOUNDS  = NO
55*10465441SEvalZeroHIDE_IN_BODY_DOCS      = NO
56*10465441SEvalZeroINTERNAL_DOCS          = NO
57*10465441SEvalZeroCASE_SENSE_NAMES       = YES
58*10465441SEvalZeroHIDE_SCOPE_NAMES       = NO
59*10465441SEvalZeroSHOW_INCLUDE_FILES     = YES
60*10465441SEvalZeroINLINE_INFO            = YES
61*10465441SEvalZeroSORT_MEMBER_DOCS       = YES
62*10465441SEvalZeroSORT_BRIEF_DOCS        = NO
63*10465441SEvalZeroSORT_BY_SCOPE_NAME     = NO
64*10465441SEvalZeroGENERATE_TODOLIST      = YES
65*10465441SEvalZeroGENERATE_TESTLIST      = YES
66*10465441SEvalZeroGENERATE_BUGLIST       = NO
67*10465441SEvalZeroGENERATE_DEPRECATEDLIST= NO
68*10465441SEvalZeroENABLED_SECTIONS       =
69*10465441SEvalZeroMAX_INITIALIZER_LINES  = 30
70*10465441SEvalZeroSHOW_USED_FILES        = NO
71*10465441SEvalZeroSHOW_DIRECTORIES       = NO
72*10465441SEvalZeroFILE_VERSION_FILTER    =
73*10465441SEvalZero#---------------------------------------------------------------------------
74*10465441SEvalZero# configuration options related to warning and progress messages
75*10465441SEvalZero#---------------------------------------------------------------------------
76*10465441SEvalZeroQUIET                  = NO
77*10465441SEvalZeroWARNINGS               = YES
78*10465441SEvalZeroWARN_IF_UNDOCUMENTED   = YES
79*10465441SEvalZeroWARN_IF_DOC_ERROR      = YES
80*10465441SEvalZeroWARN_NO_PARAMDOC       = NO
81*10465441SEvalZeroWARN_FORMAT            = "$file:$line: $text"
82*10465441SEvalZeroWARN_LOGFILE           =
83*10465441SEvalZero#---------------------------------------------------------------------------
84*10465441SEvalZero# configuration options related to the input files
85*10465441SEvalZero#---------------------------------------------------------------------------
86*10465441SEvalZeroINPUT                  = uip-doc.txt \
87*10465441SEvalZero                         pt-doc.txt \
88*10465441SEvalZero                         examples.txt \
89*10465441SEvalZero                         uip-code-style.txt \
90*10465441SEvalZero                         ../uip/uip.h \
91*10465441SEvalZero                         ../uip/uip.c \
92*10465441SEvalZero                         ../uip/uip_arch.h \
93*10465441SEvalZero                         ../uip/uip_arp.h \
94*10465441SEvalZero                         ../uip/uip_arp.c \
95*10465441SEvalZero                         ../unix/uip-conf.h \
96*10465441SEvalZero                         ../uip/uipopt.h \
97*10465441SEvalZero                         ../uip/uip-split.h \
98*10465441SEvalZero                         ../uip/uip-split.c \
99*10465441SEvalZero                         ../uip/uip-neighbor.h \
100*10465441SEvalZero                         ../uip/uip-neighbor.c \
101*10465441SEvalZero                         ../uip/pt.h \
102*10465441SEvalZero                         ../uip/lc.h \
103*10465441SEvalZero                         ../uip/lc-switch.h \
104*10465441SEvalZero                         ../uip/lc-addrlabels.h \
105*10465441SEvalZero                         ../uip/timer.h \
106*10465441SEvalZero                         ../uip/timer.c \
107*10465441SEvalZero                         ../uip/clock.h \
108*10465441SEvalZero                         ../uip/psock.h \
109*10465441SEvalZero                         ../uip/psock.c \
110*10465441SEvalZero                         ../lib/memb.c \
111*10465441SEvalZero                         ../lib/memb.h \
112*10465441SEvalZero                         ../apps/resolv/resolv.h \
113*10465441SEvalZero                         ../apps/resolv/resolv.c \
114*10465441SEvalZero                         ../apps/dhcpc/dhcpc.h \
115*10465441SEvalZero                         ../apps/dhcpc/dhcpc.c \
116*10465441SEvalZero                         ../apps/smtp/smtp.h \
117*10465441SEvalZero                         ../apps/smtp/smtp.c \
118*10465441SEvalZero                         ../apps/telnetd/telnetd.h \
119*10465441SEvalZero                         ../apps/telnetd/telnetd.c \
120*10465441SEvalZero                         ../apps/telnetd/shell.h \
121*10465441SEvalZero                         ../apps/telnetd/shell.c \
122*10465441SEvalZero                         ../apps/hello-world/hello-world.h \
123*10465441SEvalZero                         ../apps/hello-world/hello-world.c \
124*10465441SEvalZero                         ../apps/webclient/webclient.h \
125*10465441SEvalZero                         ../apps/webclient/webclient.c \
126*10465441SEvalZero                         ../apps/webserver/httpd.h \
127*10465441SEvalZero                         ../apps/webserver/httpd-cgi.h \
128*10465441SEvalZero                         ../apps/webserver/httpd-cgi.c \
129*10465441SEvalZero                         ../apps/webserver/httpd.c
130*10465441SEvalZeroFILE_PATTERNS          =
131*10465441SEvalZeroRECURSIVE              = NO
132*10465441SEvalZeroEXCLUDE                =
133*10465441SEvalZeroEXCLUDE_SYMLINKS       = NO
134*10465441SEvalZeroEXCLUDE_PATTERNS       =
135*10465441SEvalZeroEXAMPLE_PATH           = . ../apps/hello-world ../apps/smtp \
136*10465441SEvalZero                         ../apps/telnetd ../apps/resolv ../apps/webclient \
137*10465441SEvalZero			 ../apps/webserver ../unix ../apps/dhcpc
138*10465441SEvalZeroEXAMPLE_PATTERNS       =
139*10465441SEvalZeroEXAMPLE_RECURSIVE      = NO
140*10465441SEvalZeroIMAGE_PATH             =
141*10465441SEvalZeroINPUT_FILTER           =
142*10465441SEvalZeroFILTER_PATTERNS        =
143*10465441SEvalZeroFILTER_SOURCE_FILES    = NO
144*10465441SEvalZero#---------------------------------------------------------------------------
145*10465441SEvalZero# configuration options related to source browsing
146*10465441SEvalZero#---------------------------------------------------------------------------
147*10465441SEvalZeroSOURCE_BROWSER         = YES
148*10465441SEvalZeroINLINE_SOURCES         = NO
149*10465441SEvalZeroSTRIP_CODE_COMMENTS    = NO
150*10465441SEvalZeroREFERENCED_BY_RELATION = YES
151*10465441SEvalZeroREFERENCES_RELATION    = YES
152*10465441SEvalZeroUSE_HTAGS              = NO
153*10465441SEvalZeroVERBATIM_HEADERS       = NO
154*10465441SEvalZero#---------------------------------------------------------------------------
155*10465441SEvalZero# configuration options related to the alphabetical class index
156*10465441SEvalZero#---------------------------------------------------------------------------
157*10465441SEvalZeroALPHABETICAL_INDEX     = YES
158*10465441SEvalZeroCOLS_IN_ALPHA_INDEX    = 5
159*10465441SEvalZeroIGNORE_PREFIX          =
160*10465441SEvalZero#---------------------------------------------------------------------------
161*10465441SEvalZero# configuration options related to the HTML output
162*10465441SEvalZero#---------------------------------------------------------------------------
163*10465441SEvalZeroGENERATE_HTML          = YES
164*10465441SEvalZeroHTML_OUTPUT            = html
165*10465441SEvalZeroHTML_FILE_EXTENSION    = .html
166*10465441SEvalZeroHTML_HEADER            =
167*10465441SEvalZeroHTML_FOOTER            =
168*10465441SEvalZeroHTML_STYLESHEET        =
169*10465441SEvalZeroHTML_ALIGN_MEMBERS     = YES
170*10465441SEvalZeroGENERATE_HTMLHELP      = YES
171*10465441SEvalZeroCHM_FILE               =
172*10465441SEvalZeroHHC_LOCATION           =
173*10465441SEvalZeroGENERATE_CHI           = YES
174*10465441SEvalZeroBINARY_TOC             = YES
175*10465441SEvalZeroTOC_EXPAND             = NO
176*10465441SEvalZeroDISABLE_INDEX          = NO
177*10465441SEvalZeroENUM_VALUES_PER_LINE   = 4
178*10465441SEvalZeroGENERATE_TREEVIEW      = YES
179*10465441SEvalZeroTREEVIEW_WIDTH         = 250
180*10465441SEvalZero#---------------------------------------------------------------------------
181*10465441SEvalZero# configuration options related to the LaTeX output
182*10465441SEvalZero#---------------------------------------------------------------------------
183*10465441SEvalZeroGENERATE_LATEX         = YES
184*10465441SEvalZeroLATEX_OUTPUT           = latex
185*10465441SEvalZeroLATEX_CMD_NAME         = latex
186*10465441SEvalZeroMAKEINDEX_CMD_NAME     = makeindex
187*10465441SEvalZeroCOMPACT_LATEX          = NO
188*10465441SEvalZeroPAPER_TYPE             = a4wide
189*10465441SEvalZeroEXTRA_PACKAGES         =
190*10465441SEvalZeroLATEX_HEADER           = header.tex
191*10465441SEvalZeroPDF_HYPERLINKS         = YES
192*10465441SEvalZeroUSE_PDFLATEX           = YES
193*10465441SEvalZeroLATEX_BATCHMODE        = NO
194*10465441SEvalZeroLATEX_HIDE_INDICES     = NO
195*10465441SEvalZero#---------------------------------------------------------------------------
196*10465441SEvalZero# configuration options related to the RTF output
197*10465441SEvalZero#---------------------------------------------------------------------------
198*10465441SEvalZeroGENERATE_RTF           = NO
199*10465441SEvalZeroRTF_OUTPUT             = rtf
200*10465441SEvalZeroCOMPACT_RTF            = NO
201*10465441SEvalZeroRTF_HYPERLINKS         = NO
202*10465441SEvalZeroRTF_STYLESHEET_FILE    =
203*10465441SEvalZeroRTF_EXTENSIONS_FILE    =
204*10465441SEvalZero#---------------------------------------------------------------------------
205*10465441SEvalZero# configuration options related to the man page output
206*10465441SEvalZero#---------------------------------------------------------------------------
207*10465441SEvalZeroGENERATE_MAN           = NO
208*10465441SEvalZeroMAN_OUTPUT             = man
209*10465441SEvalZeroMAN_EXTENSION          = .3
210*10465441SEvalZeroMAN_LINKS              = NO
211*10465441SEvalZero#---------------------------------------------------------------------------
212*10465441SEvalZero# configuration options related to the XML output
213*10465441SEvalZero#---------------------------------------------------------------------------
214*10465441SEvalZeroGENERATE_XML           = NO
215*10465441SEvalZeroXML_OUTPUT             = xml
216*10465441SEvalZeroXML_SCHEMA             =
217*10465441SEvalZeroXML_DTD                =
218*10465441SEvalZeroXML_PROGRAMLISTING     = YES
219*10465441SEvalZero#---------------------------------------------------------------------------
220*10465441SEvalZero# configuration options for the AutoGen Definitions output
221*10465441SEvalZero#---------------------------------------------------------------------------
222*10465441SEvalZeroGENERATE_AUTOGEN_DEF   = NO
223*10465441SEvalZero#---------------------------------------------------------------------------
224*10465441SEvalZero# configuration options related to the Perl module output
225*10465441SEvalZero#---------------------------------------------------------------------------
226*10465441SEvalZeroGENERATE_PERLMOD       = NO
227*10465441SEvalZeroPERLMOD_LATEX          = NO
228*10465441SEvalZeroPERLMOD_PRETTY         = YES
229*10465441SEvalZeroPERLMOD_MAKEVAR_PREFIX =
230*10465441SEvalZero#---------------------------------------------------------------------------
231*10465441SEvalZero# Configuration options related to the preprocessor
232*10465441SEvalZero#---------------------------------------------------------------------------
233*10465441SEvalZeroENABLE_PREPROCESSING   = YES
234*10465441SEvalZeroMACRO_EXPANSION        = NO
235*10465441SEvalZeroEXPAND_ONLY_PREDEF     = NO
236*10465441SEvalZeroSEARCH_INCLUDES        = YES
237*10465441SEvalZeroINCLUDE_PATH           =
238*10465441SEvalZeroINCLUDE_FILE_PATTERNS  =
239*10465441SEvalZeroPREDEFINED             = UIP_UDP
240*10465441SEvalZeroEXPAND_AS_DEFINED      =
241*10465441SEvalZeroSKIP_FUNCTION_MACROS   = YES
242*10465441SEvalZero#---------------------------------------------------------------------------
243*10465441SEvalZero# Configuration::additions related to external references
244*10465441SEvalZero#---------------------------------------------------------------------------
245*10465441SEvalZeroTAGFILES               =
246*10465441SEvalZeroGENERATE_TAGFILE       =
247*10465441SEvalZeroALLEXTERNALS           = NO
248*10465441SEvalZeroEXTERNAL_GROUPS        = YES
249*10465441SEvalZeroPERL_PATH              = /usr/bin/perl
250*10465441SEvalZero#---------------------------------------------------------------------------
251*10465441SEvalZero# Configuration options related to the dot tool
252*10465441SEvalZero#---------------------------------------------------------------------------
253*10465441SEvalZeroCLASS_DIAGRAMS         = NO
254*10465441SEvalZeroHIDE_UNDOC_RELATIONS   = NO
255*10465441SEvalZeroHAVE_DOT               = NO
256*10465441SEvalZeroCLASS_GRAPH            = NO
257*10465441SEvalZeroCOLLABORATION_GRAPH    = NO
258*10465441SEvalZeroGROUP_GRAPHS           = NO
259*10465441SEvalZeroUML_LOOK               = NO
260*10465441SEvalZeroTEMPLATE_RELATIONS     = NO
261*10465441SEvalZeroINCLUDE_GRAPH          = NO
262*10465441SEvalZeroINCLUDED_BY_GRAPH      = NO
263*10465441SEvalZeroCALL_GRAPH             = NO
264*10465441SEvalZeroGRAPHICAL_HIERARCHY    = NO
265*10465441SEvalZeroDIRECTORY_GRAPH        = NO
266*10465441SEvalZeroDOT_IMAGE_FORMAT       = png
267*10465441SEvalZeroDOT_PATH               =
268*10465441SEvalZeroDOTFILE_DIRS           =
269*10465441SEvalZeroMAX_DOT_GRAPH_WIDTH    = 1024
270*10465441SEvalZeroMAX_DOT_GRAPH_HEIGHT   = 1024
271*10465441SEvalZeroMAX_DOT_GRAPH_DEPTH    = 0
272*10465441SEvalZeroDOT_TRANSPARENT        = NO
273*10465441SEvalZeroDOT_MULTI_TARGETS      = NO
274*10465441SEvalZeroGENERATE_LEGEND        = YES
275*10465441SEvalZeroDOT_CLEANUP            = YES
276*10465441SEvalZero#---------------------------------------------------------------------------
277*10465441SEvalZero# Configuration::additions related to the search engine
278*10465441SEvalZero#---------------------------------------------------------------------------
279*10465441SEvalZeroSEARCHENGINE           = NO
280