• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# -*- mode: doxymacs -*-
2
3#---------------------------------------------------------------------------
4# Project related configuration options
5#---------------------------------------------------------------------------
6DOXYFILE_ENCODING      = UTF-8
7PROJECT_NAME           = "ANTLR Python API"
8PROJECT_NUMBER         = 3.3
9OUTPUT_DIRECTORY       = api
10CREATE_SUBDIRS         = NO
11OUTPUT_LANGUAGE        = English
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    = YES
26INLINE_INHERITED_MEMB  = NO
27FULL_PATH_NAMES        = YES
28STRIP_FROM_PATH        = build/doc/
29STRIP_FROM_INC_PATH    =
30SHORT_NAMES            = NO
31JAVADOC_AUTOBRIEF      = NO
32MULTILINE_CPP_IS_BRIEF = NO
33DETAILS_AT_TOP         = NO
34INHERIT_DOCS           = YES
35SEPARATE_MEMBER_PAGES  = NO
36TAB_SIZE               = 8
37ALIASES                =
38OPTIMIZE_OUTPUT_FOR_C  = NO
39OPTIMIZE_OUTPUT_JAVA   = YES
40BUILTIN_STL_SUPPORT    = NO
41CPP_CLI_SUPPORT        = NO
42DISTRIBUTE_GROUP_DOC   = NO
43SUBGROUPING            = YES
44#---------------------------------------------------------------------------
45# Build related configuration options
46#---------------------------------------------------------------------------
47EXTRACT_ALL            = YES
48EXTRACT_PRIVATE        = YES
49EXTRACT_STATIC         = YES
50EXTRACT_LOCAL_CLASSES  = YES
51EXTRACT_LOCAL_METHODS  = NO
52HIDE_UNDOC_MEMBERS     = NO
53HIDE_UNDOC_CLASSES     = NO
54HIDE_FRIEND_COMPOUNDS  = NO
55HIDE_IN_BODY_DOCS      = NO
56INTERNAL_DOCS          = NO
57CASE_SENSE_NAMES       = NO
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      = NO
66GENERATE_BUGLIST       = NO
67GENERATE_DEPRECATEDLIST= NO
68ENABLED_SECTIONS       =
69MAX_INITIALIZER_LINES  = 30
70SHOW_USED_FILES        = YES
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                  = build/doc
87INPUT_ENCODING         = UTF-8
88FILE_PATTERNS          = *.c \
89                         *.cc \
90                         *.cxx \
91                         *.cpp \
92                         *.c++ \
93                         *.d \
94                         *.java \
95                         *.ii \
96                         *.ixx \
97                         *.ipp \
98                         *.i++ \
99                         *.inl \
100                         *.h \
101                         *.hh \
102                         *.hxx \
103                         *.hpp \
104                         *.h++ \
105                         *.idl \
106                         *.odl \
107                         *.cs \
108                         *.php \
109                         *.php3 \
110                         *.inc \
111                         *.m \
112                         *.mm \
113                         *.dox \
114                         *.py
115RECURSIVE              = YES
116EXCLUDE                = build/doc/antlr3/__init__.py
117EXCLUDE_SYMLINKS       = NO
118EXCLUDE_PATTERNS       =
119EXCLUDE_SYMBOLS        = dfa exceptions recognizers streams tokens constants
120EXAMPLE_PATH           =
121EXAMPLE_PATTERNS       = *
122EXAMPLE_RECURSIVE      = NO
123IMAGE_PATH             =
124INPUT_FILTER           =
125FILTER_PATTERNS        =
126FILTER_SOURCE_FILES    = NO
127#---------------------------------------------------------------------------
128# configuration options related to source browsing
129#---------------------------------------------------------------------------
130SOURCE_BROWSER         = YES
131INLINE_SOURCES         = NO
132STRIP_CODE_COMMENTS    = YES
133REFERENCED_BY_RELATION = NO
134REFERENCES_RELATION    = NO
135REFERENCES_LINK_SOURCE = YES
136USE_HTAGS              = NO
137VERBATIM_HEADERS       = YES
138#---------------------------------------------------------------------------
139# configuration options related to the alphabetical class index
140#---------------------------------------------------------------------------
141ALPHABETICAL_INDEX     = NO
142COLS_IN_ALPHA_INDEX    = 5
143IGNORE_PREFIX          =
144#---------------------------------------------------------------------------
145# configuration options related to the HTML output
146#---------------------------------------------------------------------------
147GENERATE_HTML          = YES
148HTML_OUTPUT            = .
149HTML_FILE_EXTENSION    = .html
150HTML_HEADER            =
151HTML_FOOTER            =
152HTML_STYLESHEET        =
153HTML_ALIGN_MEMBERS     = YES
154GENERATE_HTMLHELP      = NO
155CHM_FILE               =
156HHC_LOCATION           =
157GENERATE_CHI           = NO
158BINARY_TOC             = NO
159TOC_EXPAND             = NO
160DISABLE_INDEX          = NO
161ENUM_VALUES_PER_LINE   = 4
162GENERATE_TREEVIEW      = NO
163TREEVIEW_WIDTH         = 250
164#---------------------------------------------------------------------------
165# configuration options related to the LaTeX output
166#---------------------------------------------------------------------------
167GENERATE_LATEX         = NO
168LATEX_OUTPUT           = latex
169LATEX_CMD_NAME         = latex
170MAKEINDEX_CMD_NAME     = makeindex
171COMPACT_LATEX          = NO
172PAPER_TYPE             = a4wide
173EXTRA_PACKAGES         =
174LATEX_HEADER           =
175PDF_HYPERLINKS         = NO
176USE_PDFLATEX           = YES
177LATEX_BATCHMODE        = NO
178LATEX_HIDE_INDICES     = NO
179#---------------------------------------------------------------------------
180# configuration options related to the RTF output
181#---------------------------------------------------------------------------
182GENERATE_RTF           = NO
183RTF_OUTPUT             = rtf
184COMPACT_RTF            = NO
185RTF_HYPERLINKS         = NO
186RTF_STYLESHEET_FILE    =
187RTF_EXTENSIONS_FILE    =
188#---------------------------------------------------------------------------
189# configuration options related to the man page output
190#---------------------------------------------------------------------------
191GENERATE_MAN           = NO
192MAN_OUTPUT             = man
193MAN_EXTENSION          = .3
194MAN_LINKS              = NO
195#---------------------------------------------------------------------------
196# configuration options related to the XML output
197#---------------------------------------------------------------------------
198GENERATE_XML           = NO
199XML_OUTPUT             = xml
200XML_SCHEMA             =
201XML_DTD                =
202XML_PROGRAMLISTING     = YES
203#---------------------------------------------------------------------------
204# configuration options for the AutoGen Definitions output
205#---------------------------------------------------------------------------
206GENERATE_AUTOGEN_DEF   = NO
207#---------------------------------------------------------------------------
208# configuration options related to the Perl module output
209#---------------------------------------------------------------------------
210GENERATE_PERLMOD       = NO
211PERLMOD_LATEX          = NO
212PERLMOD_PRETTY         = YES
213PERLMOD_MAKEVAR_PREFIX =
214#---------------------------------------------------------------------------
215# Configuration options related to the preprocessor
216#---------------------------------------------------------------------------
217ENABLE_PREPROCESSING   = YES
218MACRO_EXPANSION        = YES
219EXPAND_ONLY_PREDEF     = NO
220SEARCH_INCLUDES        = YES
221INCLUDE_PATH           =
222INCLUDE_FILE_PATTERNS  =
223PREDEFINED             = DOXYGEN_SHOULD_SKIP_THIS
224EXPAND_AS_DEFINED      =
225SKIP_FUNCTION_MACROS   = YES
226#---------------------------------------------------------------------------
227# Configuration::additions related to external references
228#---------------------------------------------------------------------------
229TAGFILES               =
230GENERATE_TAGFILE       =
231ALLEXTERNALS           = NO
232EXTERNAL_GROUPS        = YES
233PERL_PATH              = /usr/bin/perl
234#---------------------------------------------------------------------------
235# Configuration options related to the dot tool
236#---------------------------------------------------------------------------
237CLASS_DIAGRAMS         = NO
238MSCGEN_PATH            =
239HIDE_UNDOC_RELATIONS   = YES
240HAVE_DOT               = YES
241CLASS_GRAPH            = YES
242COLLABORATION_GRAPH    = YES
243GROUP_GRAPHS           = YES
244UML_LOOK               = NO
245TEMPLATE_RELATIONS     = NO
246INCLUDE_GRAPH          = YES
247INCLUDED_BY_GRAPH      = YES
248CALL_GRAPH             = NO
249CALLER_GRAPH           = NO
250GRAPHICAL_HIERARCHY    = YES
251DIRECTORY_GRAPH        = YES
252DOT_IMAGE_FORMAT       = png
253DOT_PATH               =
254DOTFILE_DIRS           =
255DOT_GRAPH_MAX_NODES    = 50
256DOT_TRANSPARENT        = NO
257DOT_MULTI_TARGETS      = NO
258GENERATE_LEGEND        = YES
259DOT_CLEANUP            = YES
260#---------------------------------------------------------------------------
261# Configuration::additions related to the search engine
262#---------------------------------------------------------------------------
263SEARCHENGINE           = NO
264
265
266#---------------------------------------------------------------------------
267# doxypy integration
268#---------------------------------------------------------------------------
269FILTER_SOURCE_FILES = YES
270INPUT_FILTER = "python doxypy.py"
271