Home | History | Annotate | Download | only in Python
      1 # -*- mode: doxymacs -*-
      2 
      3 #---------------------------------------------------------------------------
      4 # Project related configuration options
      5 #---------------------------------------------------------------------------
      6 DOXYFILE_ENCODING      = UTF-8
      7 PROJECT_NAME           = "ANTLR Python API"
      8 PROJECT_NUMBER         = 3.3
      9 OUTPUT_DIRECTORY       = api
     10 CREATE_SUBDIRS         = NO
     11 OUTPUT_LANGUAGE        = English
     12 BRIEF_MEMBER_DESC      = YES
     13 REPEAT_BRIEF           = YES
     14 ABBREVIATE_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
     25 ALWAYS_DETAILED_SEC    = YES
     26 INLINE_INHERITED_MEMB  = NO
     27 FULL_PATH_NAMES        = YES
     28 STRIP_FROM_PATH        = build/doc/
     29 STRIP_FROM_INC_PATH    = 
     30 SHORT_NAMES            = NO
     31 JAVADOC_AUTOBRIEF      = NO
     32 MULTILINE_CPP_IS_BRIEF = NO
     33 DETAILS_AT_TOP         = NO
     34 INHERIT_DOCS           = YES
     35 SEPARATE_MEMBER_PAGES  = NO
     36 TAB_SIZE               = 8
     37 ALIASES                = 
     38 OPTIMIZE_OUTPUT_FOR_C  = NO
     39 OPTIMIZE_OUTPUT_JAVA   = YES
     40 BUILTIN_STL_SUPPORT    = NO
     41 CPP_CLI_SUPPORT        = NO
     42 DISTRIBUTE_GROUP_DOC   = NO
     43 SUBGROUPING            = YES
     44 #---------------------------------------------------------------------------
     45 # Build related configuration options
     46 #---------------------------------------------------------------------------
     47 EXTRACT_ALL            = YES
     48 EXTRACT_PRIVATE        = YES
     49 EXTRACT_STATIC         = YES
     50 EXTRACT_LOCAL_CLASSES  = YES
     51 EXTRACT_LOCAL_METHODS  = NO
     52 HIDE_UNDOC_MEMBERS     = NO
     53 HIDE_UNDOC_CLASSES     = NO
     54 HIDE_FRIEND_COMPOUNDS  = NO
     55 HIDE_IN_BODY_DOCS      = NO
     56 INTERNAL_DOCS          = NO
     57 CASE_SENSE_NAMES       = NO
     58 HIDE_SCOPE_NAMES       = NO
     59 SHOW_INCLUDE_FILES     = YES
     60 INLINE_INFO            = YES
     61 SORT_MEMBER_DOCS       = YES
     62 SORT_BRIEF_DOCS        = NO
     63 SORT_BY_SCOPE_NAME     = NO
     64 GENERATE_TODOLIST      = YES
     65 GENERATE_TESTLIST      = NO
     66 GENERATE_BUGLIST       = NO
     67 GENERATE_DEPRECATEDLIST= NO
     68 ENABLED_SECTIONS       = 
     69 MAX_INITIALIZER_LINES  = 30
     70 SHOW_USED_FILES        = YES
     71 SHOW_DIRECTORIES       = NO
     72 FILE_VERSION_FILTER    = 
     73 #---------------------------------------------------------------------------
     74 # configuration options related to warning and progress messages
     75 #---------------------------------------------------------------------------
     76 QUIET                  = NO
     77 WARNINGS               = YES
     78 WARN_IF_UNDOCUMENTED   = YES
     79 WARN_IF_DOC_ERROR      = YES
     80 WARN_NO_PARAMDOC       = NO
     81 WARN_FORMAT            = "$file:$line: $text"
     82 WARN_LOGFILE           = 
     83 #---------------------------------------------------------------------------
     84 # configuration options related to the input files
     85 #---------------------------------------------------------------------------
     86 INPUT                  = build/doc
     87 INPUT_ENCODING         = UTF-8
     88 FILE_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
    115 RECURSIVE              = YES
    116 EXCLUDE                = build/doc/antlr3/__init__.py
    117 EXCLUDE_SYMLINKS       = NO
    118 EXCLUDE_PATTERNS       = 
    119 EXCLUDE_SYMBOLS        = dfa exceptions recognizers streams tokens constants
    120 EXAMPLE_PATH           = 
    121 EXAMPLE_PATTERNS       = *
    122 EXAMPLE_RECURSIVE      = NO
    123 IMAGE_PATH             = 
    124 INPUT_FILTER           = 
    125 FILTER_PATTERNS        = 
    126 FILTER_SOURCE_FILES    = NO
    127 #---------------------------------------------------------------------------
    128 # configuration options related to source browsing
    129 #---------------------------------------------------------------------------
    130 SOURCE_BROWSER         = YES
    131 INLINE_SOURCES         = NO
    132 STRIP_CODE_COMMENTS    = YES
    133 REFERENCED_BY_RELATION = NO
    134 REFERENCES_RELATION    = NO
    135 REFERENCES_LINK_SOURCE = YES
    136 USE_HTAGS              = NO
    137 VERBATIM_HEADERS       = YES
    138 #---------------------------------------------------------------------------
    139 # configuration options related to the alphabetical class index
    140 #---------------------------------------------------------------------------
    141 ALPHABETICAL_INDEX     = NO
    142 COLS_IN_ALPHA_INDEX    = 5
    143 IGNORE_PREFIX          = 
    144 #---------------------------------------------------------------------------
    145 # configuration options related to the HTML output
    146 #---------------------------------------------------------------------------
    147 GENERATE_HTML          = YES
    148 HTML_OUTPUT            = .
    149 HTML_FILE_EXTENSION    = .html
    150 HTML_HEADER            = 
    151 HTML_FOOTER            = 
    152 HTML_STYLESHEET        = 
    153 HTML_ALIGN_MEMBERS     = YES
    154 GENERATE_HTMLHELP      = NO
    155 CHM_FILE               = 
    156 HHC_LOCATION           = 
    157 GENERATE_CHI           = NO
    158 BINARY_TOC             = NO
    159 TOC_EXPAND             = NO
    160 DISABLE_INDEX          = NO
    161 ENUM_VALUES_PER_LINE   = 4
    162 GENERATE_TREEVIEW      = NO
    163 TREEVIEW_WIDTH         = 250
    164 #---------------------------------------------------------------------------
    165 # configuration options related to the LaTeX output
    166 #---------------------------------------------------------------------------
    167 GENERATE_LATEX         = NO
    168 LATEX_OUTPUT           = latex
    169 LATEX_CMD_NAME         = latex
    170 MAKEINDEX_CMD_NAME     = makeindex
    171 COMPACT_LATEX          = NO
    172 PAPER_TYPE             = a4wide
    173 EXTRA_PACKAGES         = 
    174 LATEX_HEADER           = 
    175 PDF_HYPERLINKS         = NO
    176 USE_PDFLATEX           = YES
    177 LATEX_BATCHMODE        = NO
    178 LATEX_HIDE_INDICES     = NO
    179 #---------------------------------------------------------------------------
    180 # configuration options related to the RTF output
    181 #---------------------------------------------------------------------------
    182 GENERATE_RTF           = NO
    183 RTF_OUTPUT             = rtf
    184 COMPACT_RTF            = NO
    185 RTF_HYPERLINKS         = NO
    186 RTF_STYLESHEET_FILE    = 
    187 RTF_EXTENSIONS_FILE    = 
    188 #---------------------------------------------------------------------------
    189 # configuration options related to the man page output
    190 #---------------------------------------------------------------------------
    191 GENERATE_MAN           = NO
    192 MAN_OUTPUT             = man
    193 MAN_EXTENSION          = .3
    194 MAN_LINKS              = NO
    195 #---------------------------------------------------------------------------
    196 # configuration options related to the XML output
    197 #---------------------------------------------------------------------------
    198 GENERATE_XML           = NO
    199 XML_OUTPUT             = xml
    200 XML_SCHEMA             = 
    201 XML_DTD                = 
    202 XML_PROGRAMLISTING     = YES
    203 #---------------------------------------------------------------------------
    204 # configuration options for the AutoGen Definitions output
    205 #---------------------------------------------------------------------------
    206 GENERATE_AUTOGEN_DEF   = NO
    207 #---------------------------------------------------------------------------
    208 # configuration options related to the Perl module output
    209 #---------------------------------------------------------------------------
    210 GENERATE_PERLMOD       = NO
    211 PERLMOD_LATEX          = NO
    212 PERLMOD_PRETTY         = YES
    213 PERLMOD_MAKEVAR_PREFIX = 
    214 #---------------------------------------------------------------------------
    215 # Configuration options related to the preprocessor   
    216 #---------------------------------------------------------------------------
    217 ENABLE_PREPROCESSING   = YES
    218 MACRO_EXPANSION        = YES
    219 EXPAND_ONLY_PREDEF     = NO
    220 SEARCH_INCLUDES        = YES
    221 INCLUDE_PATH           = 
    222 INCLUDE_FILE_PATTERNS  = 
    223 PREDEFINED             = DOXYGEN_SHOULD_SKIP_THIS
    224 EXPAND_AS_DEFINED      = 
    225 SKIP_FUNCTION_MACROS   = YES
    226 #---------------------------------------------------------------------------
    227 # Configuration::additions related to external references   
    228 #---------------------------------------------------------------------------
    229 TAGFILES               = 
    230 GENERATE_TAGFILE       = 
    231 ALLEXTERNALS           = NO
    232 EXTERNAL_GROUPS        = YES
    233 PERL_PATH              = /usr/bin/perl
    234 #---------------------------------------------------------------------------
    235 # Configuration options related to the dot tool   
    236 #---------------------------------------------------------------------------
    237 CLASS_DIAGRAMS         = NO
    238 MSCGEN_PATH            = 
    239 HIDE_UNDOC_RELATIONS   = YES
    240 HAVE_DOT               = YES
    241 CLASS_GRAPH            = YES
    242 COLLABORATION_GRAPH    = YES
    243 GROUP_GRAPHS           = YES
    244 UML_LOOK               = NO
    245 TEMPLATE_RELATIONS     = NO
    246 INCLUDE_GRAPH          = YES
    247 INCLUDED_BY_GRAPH      = YES
    248 CALL_GRAPH             = NO
    249 CALLER_GRAPH           = NO
    250 GRAPHICAL_HIERARCHY    = YES
    251 DIRECTORY_GRAPH        = YES
    252 DOT_IMAGE_FORMAT       = png
    253 DOT_PATH               = 
    254 DOTFILE_DIRS           = 
    255 DOT_GRAPH_MAX_NODES    = 50
    256 DOT_TRANSPARENT        = NO
    257 DOT_MULTI_TARGETS      = NO
    258 GENERATE_LEGEND        = YES
    259 DOT_CLEANUP            = YES
    260 #---------------------------------------------------------------------------
    261 # Configuration::additions related to the search engine   
    262 #---------------------------------------------------------------------------
    263 SEARCHENGINE           = NO
    264 
    265 
    266 #---------------------------------------------------------------------------
    267 # doxypy integration
    268 #---------------------------------------------------------------------------
    269 FILTER_SOURCE_FILES = YES
    270 INPUT_FILTER = "python doxypy.py"
    271