Enable latex output
[people/dverkamp/gpxe.git] / src / doxygen.cfg
1 # Doxyfile 1.2.17
2
3 #---------------------------------------------------------------------------
4 # General configuration options
5 #---------------------------------------------------------------------------
6 PROJECT_NAME           = Etherboot
7 PROJECT_NUMBER         = 
8 OUTPUT_DIRECTORY       = @BIN@/doc
9 OUTPUT_LANGUAGE        = English
10 EXTRACT_ALL            = NO
11 EXTRACT_PRIVATE        = YES
12 EXTRACT_STATIC         = YES
13 EXTRACT_LOCAL_CLASSES  = YES
14 HIDE_UNDOC_MEMBERS     = NO
15 HIDE_UNDOC_CLASSES     = NO
16 HIDE_FRIEND_COMPOUNDS  = NO
17 BRIEF_MEMBER_DESC      = YES
18 REPEAT_BRIEF           = YES
19 ALWAYS_DETAILED_SEC    = NO
20 INLINE_INHERITED_MEMB  = NO
21 FULL_PATH_NAMES        = NO
22 STRIP_FROM_PATH        = 
23 INTERNAL_DOCS          = YES
24 STRIP_CODE_COMMENTS    = NO
25 CASE_SENSE_NAMES       = YES
26 SHORT_NAMES            = NO
27 HIDE_SCOPE_NAMES       = NO
28 VERBATIM_HEADERS       = YES
29 SHOW_INCLUDE_FILES     = YES
30 JAVADOC_AUTOBRIEF      = YES
31 MULTILINE_CPP_IS_BRIEF = NO
32 DETAILS_AT_TOP         = YES
33 INHERIT_DOCS           = YES
34 INLINE_INFO            = YES
35 SORT_MEMBER_DOCS       = NO
36 DISTRIBUTE_GROUP_DOC   = NO
37 TAB_SIZE               = 8
38 GENERATE_TODOLIST      = YES
39 GENERATE_TESTLIST      = YES
40 GENERATE_BUGLIST       = YES
41 GENERATE_DEPRECATEDLIST= YES
42 ALIASES                = v=@param \
43                          ret=@retval \
44                          err=@exception
45 ENABLED_SECTIONS       = 
46 MAX_INITIALIZER_LINES  = 30
47 OPTIMIZE_OUTPUT_FOR_C  = YES
48 OPTIMIZE_OUTPUT_JAVA   = NO
49 SHOW_USED_FILES        = YES
50 #---------------------------------------------------------------------------
51 # configuration options related to warning and progress messages
52 #---------------------------------------------------------------------------
53 QUIET                  = NO
54 WARNINGS               = YES
55 WARN_IF_UNDOCUMENTED   = YES
56 WARN_FORMAT            = 
57 WARN_LOGFILE           = 
58 #---------------------------------------------------------------------------
59 # configuration options related to the input files
60 #---------------------------------------------------------------------------
61 INPUT                  = @SRCDIRS@ \
62                          include \
63                          arch/@ARCH@/include \
64                          doc
65 FILE_PATTERNS          = *.c \
66                          *.h \
67                          *.S \
68                          *.dox
69 RECURSIVE              = NO
70 EXCLUDE                = 
71 EXCLUDE_SYMLINKS       = NO
72 EXCLUDE_PATTERNS       = 
73 EXAMPLE_PATH           = 
74 EXAMPLE_PATTERNS       = 
75 EXAMPLE_RECURSIVE      = NO
76 IMAGE_PATH             = 
77 INPUT_FILTER           = 
78 FILTER_SOURCE_FILES    = YES
79 #---------------------------------------------------------------------------
80 # configuration options related to source browsing
81 #---------------------------------------------------------------------------
82 SOURCE_BROWSER         = YES
83 INLINE_SOURCES         = NO
84 REFERENCED_BY_RELATION = YES
85 REFERENCES_RELATION    = NO
86 #---------------------------------------------------------------------------
87 # configuration options related to the alphabetical class index
88 #---------------------------------------------------------------------------
89 ALPHABETICAL_INDEX     = YES
90 COLS_IN_ALPHA_INDEX    = 5
91 IGNORE_PREFIX          = 
92 #---------------------------------------------------------------------------
93 # configuration options related to the HTML output
94 #---------------------------------------------------------------------------
95 GENERATE_HTML          = YES
96 HTML_OUTPUT            = 
97 HTML_FILE_EXTENSION    = 
98 HTML_HEADER            = 
99 HTML_FOOTER            = 
100 HTML_STYLESHEET        = 
101 HTML_ALIGN_MEMBERS     = YES
102 GENERATE_HTMLHELP      = NO
103 CHM_FILE               = 
104 HHC_LOCATION           = 
105 GENERATE_CHI           = NO
106 BINARY_TOC             = NO
107 TOC_EXPAND             = NO
108 DISABLE_INDEX          = NO
109 ENUM_VALUES_PER_LINE   = 4
110 GENERATE_TREEVIEW      = NO
111 TREEVIEW_WIDTH         = 250
112 #---------------------------------------------------------------------------
113 # configuration options related to the LaTeX output
114 #---------------------------------------------------------------------------
115 GENERATE_LATEX         = YES
116 LATEX_OUTPUT           = 
117 LATEX_CMD_NAME         = latex
118 MAKEINDEX_CMD_NAME     = makeindex
119 COMPACT_LATEX          = YES
120 PAPER_TYPE             = a4wide
121 EXTRA_PACKAGES         = 
122 LATEX_HEADER           = 
123 PDF_HYPERLINKS         = NO
124 USE_PDFLATEX           = NO
125 LATEX_BATCHMODE        = YES
126 #---------------------------------------------------------------------------
127 # configuration options related to the RTF output
128 #---------------------------------------------------------------------------
129 GENERATE_RTF           = NO
130 RTF_OUTPUT             = 
131 COMPACT_RTF            = NO
132 RTF_HYPERLINKS         = NO
133 RTF_STYLESHEET_FILE    = 
134 RTF_EXTENSIONS_FILE    = 
135 #---------------------------------------------------------------------------
136 # configuration options related to the man page output
137 #---------------------------------------------------------------------------
138 GENERATE_MAN           = YES
139 MAN_OUTPUT             = 
140 MAN_EXTENSION          = 
141 MAN_LINKS              = YES
142 #---------------------------------------------------------------------------
143 # configuration options related to the XML output
144 #---------------------------------------------------------------------------
145 GENERATE_XML           = NO
146 XML_SCHEMA             = 
147 XML_DTD                = 
148 #---------------------------------------------------------------------------
149 # configuration options for the AutoGen Definitions output
150 #---------------------------------------------------------------------------
151 GENERATE_AUTOGEN_DEF   = NO
152 #---------------------------------------------------------------------------
153 # Configuration options related to the preprocessor   
154 #---------------------------------------------------------------------------
155 ENABLE_PREPROCESSING   = YES
156 MACRO_EXPANSION        = YES
157 EXPAND_ONLY_PREDEF     = YES
158 SEARCH_INCLUDES        = YES
159 INCLUDE_PATH           = include \
160                          arch/@ARCH@/include
161 INCLUDE_FILE_PATTERNS  = 
162 PREDEFINED             = DOXYGEN=1
163 EXPAND_AS_DEFINED      = __attribute__ \
164                          PACKED \
165                          __unused \
166                          __used \
167                          __aligned \
168                          __table \
169                          __table_start \
170                          __table_end
171 SKIP_FUNCTION_MACROS   = YES
172 #---------------------------------------------------------------------------
173 # Configuration::addtions related to external references   
174 #---------------------------------------------------------------------------
175 TAGFILES               = 
176 GENERATE_TAGFILE       = 
177 ALLEXTERNALS           = NO
178 EXTERNAL_GROUPS        = YES
179 PERL_PATH              = 
180 #---------------------------------------------------------------------------
181 # Configuration options related to the dot tool   
182 #---------------------------------------------------------------------------
183 CLASS_DIAGRAMS         = YES
184 HIDE_UNDOC_RELATIONS   = YES
185 HAVE_DOT               = NO
186 CLASS_GRAPH            = YES
187 COLLABORATION_GRAPH    = YES
188 TEMPLATE_RELATIONS     = YES
189 INCLUDE_GRAPH          = YES
190 INCLUDED_BY_GRAPH      = YES
191 GRAPHICAL_HIERARCHY    = YES
192 DOT_IMAGE_FORMAT       = png
193 DOT_PATH               = 
194 DOTFILE_DIRS           = 
195 MAX_DOT_GRAPH_WIDTH    = 1024
196 MAX_DOT_GRAPH_HEIGHT   = 1024
197 GENERATE_LEGEND        = YES
198 DOT_CLEANUP            = YES
199 #---------------------------------------------------------------------------
200 # Configuration::addtions related to the search engine   
201 #---------------------------------------------------------------------------
202 SEARCHENGINE           = NO
203 CGI_NAME               = 
204 CGI_URL                = 
205 DOC_URL                = 
206 DOC_ABSPATH            = 
207 BIN_ABSPATH            = 
208 EXT_DOC_PATHS          =