xref: /aosp_15_r20/external/antlr/runtime/Python/doxyfile (revision 16467b971bd3e2009fad32dd79016f2c7e421deb)
1*16467b97STreehugger Robot# -*- mode: doxymacs -*-
2*16467b97STreehugger Robot
3*16467b97STreehugger Robot#---------------------------------------------------------------------------
4*16467b97STreehugger Robot# Project related configuration options
5*16467b97STreehugger Robot#---------------------------------------------------------------------------
6*16467b97STreehugger RobotDOXYFILE_ENCODING      = UTF-8
7*16467b97STreehugger RobotPROJECT_NAME           = "ANTLR Python API"
8*16467b97STreehugger RobotPROJECT_NUMBER         = 3.3
9*16467b97STreehugger RobotOUTPUT_DIRECTORY       = api
10*16467b97STreehugger RobotCREATE_SUBDIRS         = NO
11*16467b97STreehugger RobotOUTPUT_LANGUAGE        = English
12*16467b97STreehugger RobotBRIEF_MEMBER_DESC      = YES
13*16467b97STreehugger RobotREPEAT_BRIEF           = YES
14*16467b97STreehugger RobotABBREVIATE_BRIEF       = "The $name class" \
15*16467b97STreehugger Robot                         "The $name widget" \
16*16467b97STreehugger Robot                         "The $name file" \
17*16467b97STreehugger Robot                         is \
18*16467b97STreehugger Robot                         provides \
19*16467b97STreehugger Robot                         specifies \
20*16467b97STreehugger Robot                         contains \
21*16467b97STreehugger Robot                         represents \
22*16467b97STreehugger Robot                         a \
23*16467b97STreehugger Robot                         an \
24*16467b97STreehugger Robot                         the
25*16467b97STreehugger RobotALWAYS_DETAILED_SEC    = YES
26*16467b97STreehugger RobotINLINE_INHERITED_MEMB  = NO
27*16467b97STreehugger RobotFULL_PATH_NAMES        = YES
28*16467b97STreehugger RobotSTRIP_FROM_PATH        = build/doc/
29*16467b97STreehugger RobotSTRIP_FROM_INC_PATH    =
30*16467b97STreehugger RobotSHORT_NAMES            = NO
31*16467b97STreehugger RobotJAVADOC_AUTOBRIEF      = NO
32*16467b97STreehugger RobotMULTILINE_CPP_IS_BRIEF = NO
33*16467b97STreehugger RobotDETAILS_AT_TOP         = NO
34*16467b97STreehugger RobotINHERIT_DOCS           = YES
35*16467b97STreehugger RobotSEPARATE_MEMBER_PAGES  = NO
36*16467b97STreehugger RobotTAB_SIZE               = 8
37*16467b97STreehugger RobotALIASES                =
38*16467b97STreehugger RobotOPTIMIZE_OUTPUT_FOR_C  = NO
39*16467b97STreehugger RobotOPTIMIZE_OUTPUT_JAVA   = YES
40*16467b97STreehugger RobotBUILTIN_STL_SUPPORT    = NO
41*16467b97STreehugger RobotCPP_CLI_SUPPORT        = NO
42*16467b97STreehugger RobotDISTRIBUTE_GROUP_DOC   = NO
43*16467b97STreehugger RobotSUBGROUPING            = YES
44*16467b97STreehugger Robot#---------------------------------------------------------------------------
45*16467b97STreehugger Robot# Build related configuration options
46*16467b97STreehugger Robot#---------------------------------------------------------------------------
47*16467b97STreehugger RobotEXTRACT_ALL            = YES
48*16467b97STreehugger RobotEXTRACT_PRIVATE        = YES
49*16467b97STreehugger RobotEXTRACT_STATIC         = YES
50*16467b97STreehugger RobotEXTRACT_LOCAL_CLASSES  = YES
51*16467b97STreehugger RobotEXTRACT_LOCAL_METHODS  = NO
52*16467b97STreehugger RobotHIDE_UNDOC_MEMBERS     = NO
53*16467b97STreehugger RobotHIDE_UNDOC_CLASSES     = NO
54*16467b97STreehugger RobotHIDE_FRIEND_COMPOUNDS  = NO
55*16467b97STreehugger RobotHIDE_IN_BODY_DOCS      = NO
56*16467b97STreehugger RobotINTERNAL_DOCS          = NO
57*16467b97STreehugger RobotCASE_SENSE_NAMES       = NO
58*16467b97STreehugger RobotHIDE_SCOPE_NAMES       = NO
59*16467b97STreehugger RobotSHOW_INCLUDE_FILES     = YES
60*16467b97STreehugger RobotINLINE_INFO            = YES
61*16467b97STreehugger RobotSORT_MEMBER_DOCS       = YES
62*16467b97STreehugger RobotSORT_BRIEF_DOCS        = NO
63*16467b97STreehugger RobotSORT_BY_SCOPE_NAME     = NO
64*16467b97STreehugger RobotGENERATE_TODOLIST      = YES
65*16467b97STreehugger RobotGENERATE_TESTLIST      = NO
66*16467b97STreehugger RobotGENERATE_BUGLIST       = NO
67*16467b97STreehugger RobotGENERATE_DEPRECATEDLIST= NO
68*16467b97STreehugger RobotENABLED_SECTIONS       =
69*16467b97STreehugger RobotMAX_INITIALIZER_LINES  = 30
70*16467b97STreehugger RobotSHOW_USED_FILES        = YES
71*16467b97STreehugger RobotSHOW_DIRECTORIES       = NO
72*16467b97STreehugger RobotFILE_VERSION_FILTER    =
73*16467b97STreehugger Robot#---------------------------------------------------------------------------
74*16467b97STreehugger Robot# configuration options related to warning and progress messages
75*16467b97STreehugger Robot#---------------------------------------------------------------------------
76*16467b97STreehugger RobotQUIET                  = NO
77*16467b97STreehugger RobotWARNINGS               = YES
78*16467b97STreehugger RobotWARN_IF_UNDOCUMENTED   = YES
79*16467b97STreehugger RobotWARN_IF_DOC_ERROR      = YES
80*16467b97STreehugger RobotWARN_NO_PARAMDOC       = NO
81*16467b97STreehugger RobotWARN_FORMAT            = "$file:$line: $text"
82*16467b97STreehugger RobotWARN_LOGFILE           =
83*16467b97STreehugger Robot#---------------------------------------------------------------------------
84*16467b97STreehugger Robot# configuration options related to the input files
85*16467b97STreehugger Robot#---------------------------------------------------------------------------
86*16467b97STreehugger RobotINPUT                  = build/doc
87*16467b97STreehugger RobotINPUT_ENCODING         = UTF-8
88*16467b97STreehugger RobotFILE_PATTERNS          = *.c \
89*16467b97STreehugger Robot                         *.cc \
90*16467b97STreehugger Robot                         *.cxx \
91*16467b97STreehugger Robot                         *.cpp \
92*16467b97STreehugger Robot                         *.c++ \
93*16467b97STreehugger Robot                         *.d \
94*16467b97STreehugger Robot                         *.java \
95*16467b97STreehugger Robot                         *.ii \
96*16467b97STreehugger Robot                         *.ixx \
97*16467b97STreehugger Robot                         *.ipp \
98*16467b97STreehugger Robot                         *.i++ \
99*16467b97STreehugger Robot                         *.inl \
100*16467b97STreehugger Robot                         *.h \
101*16467b97STreehugger Robot                         *.hh \
102*16467b97STreehugger Robot                         *.hxx \
103*16467b97STreehugger Robot                         *.hpp \
104*16467b97STreehugger Robot                         *.h++ \
105*16467b97STreehugger Robot                         *.idl \
106*16467b97STreehugger Robot                         *.odl \
107*16467b97STreehugger Robot                         *.cs \
108*16467b97STreehugger Robot                         *.php \
109*16467b97STreehugger Robot                         *.php3 \
110*16467b97STreehugger Robot                         *.inc \
111*16467b97STreehugger Robot                         *.m \
112*16467b97STreehugger Robot                         *.mm \
113*16467b97STreehugger Robot                         *.dox \
114*16467b97STreehugger Robot                         *.py
115*16467b97STreehugger RobotRECURSIVE              = YES
116*16467b97STreehugger RobotEXCLUDE                = build/doc/antlr3/__init__.py
117*16467b97STreehugger RobotEXCLUDE_SYMLINKS       = NO
118*16467b97STreehugger RobotEXCLUDE_PATTERNS       =
119*16467b97STreehugger RobotEXCLUDE_SYMBOLS        = dfa exceptions recognizers streams tokens constants
120*16467b97STreehugger RobotEXAMPLE_PATH           =
121*16467b97STreehugger RobotEXAMPLE_PATTERNS       = *
122*16467b97STreehugger RobotEXAMPLE_RECURSIVE      = NO
123*16467b97STreehugger RobotIMAGE_PATH             =
124*16467b97STreehugger RobotINPUT_FILTER           =
125*16467b97STreehugger RobotFILTER_PATTERNS        =
126*16467b97STreehugger RobotFILTER_SOURCE_FILES    = NO
127*16467b97STreehugger Robot#---------------------------------------------------------------------------
128*16467b97STreehugger Robot# configuration options related to source browsing
129*16467b97STreehugger Robot#---------------------------------------------------------------------------
130*16467b97STreehugger RobotSOURCE_BROWSER         = YES
131*16467b97STreehugger RobotINLINE_SOURCES         = NO
132*16467b97STreehugger RobotSTRIP_CODE_COMMENTS    = YES
133*16467b97STreehugger RobotREFERENCED_BY_RELATION = NO
134*16467b97STreehugger RobotREFERENCES_RELATION    = NO
135*16467b97STreehugger RobotREFERENCES_LINK_SOURCE = YES
136*16467b97STreehugger RobotUSE_HTAGS              = NO
137*16467b97STreehugger RobotVERBATIM_HEADERS       = YES
138*16467b97STreehugger Robot#---------------------------------------------------------------------------
139*16467b97STreehugger Robot# configuration options related to the alphabetical class index
140*16467b97STreehugger Robot#---------------------------------------------------------------------------
141*16467b97STreehugger RobotALPHABETICAL_INDEX     = NO
142*16467b97STreehugger RobotCOLS_IN_ALPHA_INDEX    = 5
143*16467b97STreehugger RobotIGNORE_PREFIX          =
144*16467b97STreehugger Robot#---------------------------------------------------------------------------
145*16467b97STreehugger Robot# configuration options related to the HTML output
146*16467b97STreehugger Robot#---------------------------------------------------------------------------
147*16467b97STreehugger RobotGENERATE_HTML          = YES
148*16467b97STreehugger RobotHTML_OUTPUT            = .
149*16467b97STreehugger RobotHTML_FILE_EXTENSION    = .html
150*16467b97STreehugger RobotHTML_HEADER            =
151*16467b97STreehugger RobotHTML_FOOTER            =
152*16467b97STreehugger RobotHTML_STYLESHEET        =
153*16467b97STreehugger RobotHTML_ALIGN_MEMBERS     = YES
154*16467b97STreehugger RobotGENERATE_HTMLHELP      = NO
155*16467b97STreehugger RobotCHM_FILE               =
156*16467b97STreehugger RobotHHC_LOCATION           =
157*16467b97STreehugger RobotGENERATE_CHI           = NO
158*16467b97STreehugger RobotBINARY_TOC             = NO
159*16467b97STreehugger RobotTOC_EXPAND             = NO
160*16467b97STreehugger RobotDISABLE_INDEX          = NO
161*16467b97STreehugger RobotENUM_VALUES_PER_LINE   = 4
162*16467b97STreehugger RobotGENERATE_TREEVIEW      = NO
163*16467b97STreehugger RobotTREEVIEW_WIDTH         = 250
164*16467b97STreehugger Robot#---------------------------------------------------------------------------
165*16467b97STreehugger Robot# configuration options related to the LaTeX output
166*16467b97STreehugger Robot#---------------------------------------------------------------------------
167*16467b97STreehugger RobotGENERATE_LATEX         = NO
168*16467b97STreehugger RobotLATEX_OUTPUT           = latex
169*16467b97STreehugger RobotLATEX_CMD_NAME         = latex
170*16467b97STreehugger RobotMAKEINDEX_CMD_NAME     = makeindex
171*16467b97STreehugger RobotCOMPACT_LATEX          = NO
172*16467b97STreehugger RobotPAPER_TYPE             = a4wide
173*16467b97STreehugger RobotEXTRA_PACKAGES         =
174*16467b97STreehugger RobotLATEX_HEADER           =
175*16467b97STreehugger RobotPDF_HYPERLINKS         = NO
176*16467b97STreehugger RobotUSE_PDFLATEX           = YES
177*16467b97STreehugger RobotLATEX_BATCHMODE        = NO
178*16467b97STreehugger RobotLATEX_HIDE_INDICES     = NO
179*16467b97STreehugger Robot#---------------------------------------------------------------------------
180*16467b97STreehugger Robot# configuration options related to the RTF output
181*16467b97STreehugger Robot#---------------------------------------------------------------------------
182*16467b97STreehugger RobotGENERATE_RTF           = NO
183*16467b97STreehugger RobotRTF_OUTPUT             = rtf
184*16467b97STreehugger RobotCOMPACT_RTF            = NO
185*16467b97STreehugger RobotRTF_HYPERLINKS         = NO
186*16467b97STreehugger RobotRTF_STYLESHEET_FILE    =
187*16467b97STreehugger RobotRTF_EXTENSIONS_FILE    =
188*16467b97STreehugger Robot#---------------------------------------------------------------------------
189*16467b97STreehugger Robot# configuration options related to the man page output
190*16467b97STreehugger Robot#---------------------------------------------------------------------------
191*16467b97STreehugger RobotGENERATE_MAN           = NO
192*16467b97STreehugger RobotMAN_OUTPUT             = man
193*16467b97STreehugger RobotMAN_EXTENSION          = .3
194*16467b97STreehugger RobotMAN_LINKS              = NO
195*16467b97STreehugger Robot#---------------------------------------------------------------------------
196*16467b97STreehugger Robot# configuration options related to the XML output
197*16467b97STreehugger Robot#---------------------------------------------------------------------------
198*16467b97STreehugger RobotGENERATE_XML           = NO
199*16467b97STreehugger RobotXML_OUTPUT             = xml
200*16467b97STreehugger RobotXML_SCHEMA             =
201*16467b97STreehugger RobotXML_DTD                =
202*16467b97STreehugger RobotXML_PROGRAMLISTING     = YES
203*16467b97STreehugger Robot#---------------------------------------------------------------------------
204*16467b97STreehugger Robot# configuration options for the AutoGen Definitions output
205*16467b97STreehugger Robot#---------------------------------------------------------------------------
206*16467b97STreehugger RobotGENERATE_AUTOGEN_DEF   = NO
207*16467b97STreehugger Robot#---------------------------------------------------------------------------
208*16467b97STreehugger Robot# configuration options related to the Perl module output
209*16467b97STreehugger Robot#---------------------------------------------------------------------------
210*16467b97STreehugger RobotGENERATE_PERLMOD       = NO
211*16467b97STreehugger RobotPERLMOD_LATEX          = NO
212*16467b97STreehugger RobotPERLMOD_PRETTY         = YES
213*16467b97STreehugger RobotPERLMOD_MAKEVAR_PREFIX =
214*16467b97STreehugger Robot#---------------------------------------------------------------------------
215*16467b97STreehugger Robot# Configuration options related to the preprocessor
216*16467b97STreehugger Robot#---------------------------------------------------------------------------
217*16467b97STreehugger RobotENABLE_PREPROCESSING   = YES
218*16467b97STreehugger RobotMACRO_EXPANSION        = YES
219*16467b97STreehugger RobotEXPAND_ONLY_PREDEF     = NO
220*16467b97STreehugger RobotSEARCH_INCLUDES        = YES
221*16467b97STreehugger RobotINCLUDE_PATH           =
222*16467b97STreehugger RobotINCLUDE_FILE_PATTERNS  =
223*16467b97STreehugger RobotPREDEFINED             = DOXYGEN_SHOULD_SKIP_THIS
224*16467b97STreehugger RobotEXPAND_AS_DEFINED      =
225*16467b97STreehugger RobotSKIP_FUNCTION_MACROS   = YES
226*16467b97STreehugger Robot#---------------------------------------------------------------------------
227*16467b97STreehugger Robot# Configuration::additions related to external references
228*16467b97STreehugger Robot#---------------------------------------------------------------------------
229*16467b97STreehugger RobotTAGFILES               =
230*16467b97STreehugger RobotGENERATE_TAGFILE       =
231*16467b97STreehugger RobotALLEXTERNALS           = NO
232*16467b97STreehugger RobotEXTERNAL_GROUPS        = YES
233*16467b97STreehugger RobotPERL_PATH              = /usr/bin/perl
234*16467b97STreehugger Robot#---------------------------------------------------------------------------
235*16467b97STreehugger Robot# Configuration options related to the dot tool
236*16467b97STreehugger Robot#---------------------------------------------------------------------------
237*16467b97STreehugger RobotCLASS_DIAGRAMS         = NO
238*16467b97STreehugger RobotMSCGEN_PATH            =
239*16467b97STreehugger RobotHIDE_UNDOC_RELATIONS   = YES
240*16467b97STreehugger RobotHAVE_DOT               = YES
241*16467b97STreehugger RobotCLASS_GRAPH            = YES
242*16467b97STreehugger RobotCOLLABORATION_GRAPH    = YES
243*16467b97STreehugger RobotGROUP_GRAPHS           = YES
244*16467b97STreehugger RobotUML_LOOK               = NO
245*16467b97STreehugger RobotTEMPLATE_RELATIONS     = NO
246*16467b97STreehugger RobotINCLUDE_GRAPH          = YES
247*16467b97STreehugger RobotINCLUDED_BY_GRAPH      = YES
248*16467b97STreehugger RobotCALL_GRAPH             = NO
249*16467b97STreehugger RobotCALLER_GRAPH           = NO
250*16467b97STreehugger RobotGRAPHICAL_HIERARCHY    = YES
251*16467b97STreehugger RobotDIRECTORY_GRAPH        = YES
252*16467b97STreehugger RobotDOT_IMAGE_FORMAT       = png
253*16467b97STreehugger RobotDOT_PATH               =
254*16467b97STreehugger RobotDOTFILE_DIRS           =
255*16467b97STreehugger RobotDOT_GRAPH_MAX_NODES    = 50
256*16467b97STreehugger RobotDOT_TRANSPARENT        = NO
257*16467b97STreehugger RobotDOT_MULTI_TARGETS      = NO
258*16467b97STreehugger RobotGENERATE_LEGEND        = YES
259*16467b97STreehugger RobotDOT_CLEANUP            = YES
260*16467b97STreehugger Robot#---------------------------------------------------------------------------
261*16467b97STreehugger Robot# Configuration::additions related to the search engine
262*16467b97STreehugger Robot#---------------------------------------------------------------------------
263*16467b97STreehugger RobotSEARCHENGINE           = NO
264*16467b97STreehugger Robot
265*16467b97STreehugger Robot
266*16467b97STreehugger Robot#---------------------------------------------------------------------------
267*16467b97STreehugger Robot# doxypy integration
268*16467b97STreehugger Robot#---------------------------------------------------------------------------
269*16467b97STreehugger RobotFILTER_SOURCE_FILES = YES
270*16467b97STreehugger RobotINPUT_FILTER = "python doxypy.py"
271