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