Synced across updates from Etherboot 5.4 tree
[people/xl0/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 FILE_PATTERNS          = 
65 RECURSIVE              = NO
66 EXCLUDE                = 
67 EXCLUDE_SYMLINKS       = NO
68 EXCLUDE_PATTERNS       = 
69 EXAMPLE_PATH           = 
70 EXAMPLE_PATTERNS       = 
71 EXAMPLE_RECURSIVE      = NO
72 IMAGE_PATH             = 
73 INPUT_FILTER           = 
74 FILTER_SOURCE_FILES    = YES
75 #---------------------------------------------------------------------------
76 # configuration options related to source browsing
77 #---------------------------------------------------------------------------
78 SOURCE_BROWSER         = YES
79 INLINE_SOURCES         = NO
80 REFERENCED_BY_RELATION = YES
81 REFERENCES_RELATION    = NO
82 #---------------------------------------------------------------------------
83 # configuration options related to the alphabetical class index
84 #---------------------------------------------------------------------------
85 ALPHABETICAL_INDEX     = YES
86 COLS_IN_ALPHA_INDEX    = 5
87 IGNORE_PREFIX          = 
88 #---------------------------------------------------------------------------
89 # configuration options related to the HTML output
90 #---------------------------------------------------------------------------
91 GENERATE_HTML          = YES
92 HTML_OUTPUT            = 
93 HTML_FILE_EXTENSION    = 
94 HTML_HEADER            = 
95 HTML_FOOTER            = 
96 HTML_STYLESHEET        = 
97 HTML_ALIGN_MEMBERS     = YES
98 GENERATE_HTMLHELP      = NO
99 CHM_FILE               = 
100 HHC_LOCATION           = 
101 GENERATE_CHI           = NO
102 BINARY_TOC             = NO
103 TOC_EXPAND             = NO
104 DISABLE_INDEX          = NO
105 ENUM_VALUES_PER_LINE   = 4
106 GENERATE_TREEVIEW      = NO
107 TREEVIEW_WIDTH         = 250
108 #---------------------------------------------------------------------------
109 # configuration options related to the LaTeX output
110 #---------------------------------------------------------------------------
111 GENERATE_LATEX         = YES
112 LATEX_OUTPUT           = 
113 LATEX_CMD_NAME         = 
114 MAKEINDEX_CMD_NAME     = 
115 COMPACT_LATEX          = YES
116 PAPER_TYPE             = a4wide
117 EXTRA_PACKAGES         = 
118 LATEX_HEADER           = 
119 PDF_HYPERLINKS         = NO
120 USE_PDFLATEX           = NO
121 LATEX_BATCHMODE        = NO
122 #---------------------------------------------------------------------------
123 # configuration options related to the RTF output
124 #---------------------------------------------------------------------------
125 GENERATE_RTF           = NO
126 RTF_OUTPUT             = 
127 COMPACT_RTF            = NO
128 RTF_HYPERLINKS         = NO
129 RTF_STYLESHEET_FILE    = 
130 RTF_EXTENSIONS_FILE    = 
131 #---------------------------------------------------------------------------
132 # configuration options related to the man page output
133 #---------------------------------------------------------------------------
134 GENERATE_MAN           = YES
135 MAN_OUTPUT             = 
136 MAN_EXTENSION          = 
137 MAN_LINKS              = YES
138 #---------------------------------------------------------------------------
139 # configuration options related to the XML output
140 #---------------------------------------------------------------------------
141 GENERATE_XML           = NO
142 XML_SCHEMA             = 
143 XML_DTD                = 
144 #---------------------------------------------------------------------------
145 # configuration options for the AutoGen Definitions output
146 #---------------------------------------------------------------------------
147 GENERATE_AUTOGEN_DEF   = NO
148 #---------------------------------------------------------------------------
149 # Configuration options related to the preprocessor   
150 #---------------------------------------------------------------------------
151 ENABLE_PREPROCESSING   = YES
152 MACRO_EXPANSION        = YES
153 EXPAND_ONLY_PREDEF     = YES
154 SEARCH_INCLUDES        = YES
155 INCLUDE_PATH           = include \
156                          arch/@ARCH@/include
157 INCLUDE_FILE_PATTERNS  = 
158 PREDEFINED             = DOXYGEN=1
159 EXPAND_AS_DEFINED      = __attribute__ \
160                          PACKED \
161                          __unused \
162                          __used \
163                          __aligned \
164                          __table \
165                          __table_start \
166                          __table_end
167 SKIP_FUNCTION_MACROS   = YES
168 #---------------------------------------------------------------------------
169 # Configuration::addtions related to external references   
170 #---------------------------------------------------------------------------
171 TAGFILES               = 
172 GENERATE_TAGFILE       = 
173 ALLEXTERNALS           = NO
174 EXTERNAL_GROUPS        = YES
175 PERL_PATH              = 
176 #---------------------------------------------------------------------------
177 # Configuration options related to the dot tool   
178 #---------------------------------------------------------------------------
179 CLASS_DIAGRAMS         = YES
180 HIDE_UNDOC_RELATIONS   = YES
181 HAVE_DOT               = NO
182 CLASS_GRAPH            = YES
183 COLLABORATION_GRAPH    = YES
184 TEMPLATE_RELATIONS     = YES
185 INCLUDE_GRAPH          = YES
186 INCLUDED_BY_GRAPH      = YES
187 GRAPHICAL_HIERARCHY    = YES
188 DOT_IMAGE_FORMAT       = png
189 DOT_PATH               = 
190 DOTFILE_DIRS           = 
191 MAX_DOT_GRAPH_WIDTH    = 1024
192 MAX_DOT_GRAPH_HEIGHT   = 1024
193 GENERATE_LEGEND        = YES
194 DOT_CLEANUP            = YES
195 #---------------------------------------------------------------------------
196 # Configuration::addtions related to the search engine   
197 #---------------------------------------------------------------------------
198 SEARCHENGINE           = NO
199 CGI_NAME               = 
200 CGI_URL                = 
201 DOC_URL                = 
202 DOC_ABSPATH            = 
203 BIN_ABSPATH            = 
204 EXT_DOC_PATHS          =