xref: /openbmc/libpldm/Doxyfile.in (revision 7d87f8dcd6334a9d57cfc65c6efb78f1e4a9ec44)
1# Doxyfile 1.9.8
2
3#---------------------------------------------------------------------------
4# Project related configuration options
5#---------------------------------------------------------------------------
6DOXYFILE_ENCODING      = UTF-8
7PROJECT_NAME           = @project@
8PROJECT_NUMBER         = @version@
9PROJECT_BRIEF          = @description@
10PROJECT_LOGO           =
11OUTPUT_DIRECTORY       =
12CREATE_SUBDIRS         = NO
13CREATE_SUBDIRS_LEVEL   = 8
14ALLOW_UNICODE_NAMES    = NO
15OUTPUT_LANGUAGE        = English
16BRIEF_MEMBER_DESC      = YES
17REPEAT_BRIEF           = YES
18ABBREVIATE_BRIEF       = "The $name class" \
19                         "The $name widget" \
20                         "The $name file" \
21                         is \
22                         provides \
23                         specifies \
24                         contains \
25                         represents \
26                         a \
27                         an \
28                         the
29ALWAYS_DETAILED_SEC    = NO
30INLINE_INHERITED_MEMB  = NO
31FULL_PATH_NAMES        = YES
32STRIP_FROM_PATH        =
33STRIP_FROM_INC_PATH    =
34SHORT_NAMES            = NO
35JAVADOC_AUTOBRIEF      = NO
36JAVADOC_BANNER         = NO
37QT_AUTOBRIEF           = NO
38MULTILINE_CPP_IS_BRIEF = NO
39PYTHON_DOCSTRING       = YES
40INHERIT_DOCS           = YES
41SEPARATE_MEMBER_PAGES  = NO
42TAB_SIZE               = 4
43ALIASES                =
44OPTIMIZE_OUTPUT_FOR_C  = YES
45OPTIMIZE_OUTPUT_JAVA   = NO
46OPTIMIZE_FOR_FORTRAN   = NO
47OPTIMIZE_OUTPUT_VHDL   = NO
48OPTIMIZE_OUTPUT_SLICE  = NO
49EXTENSION_MAPPING      =
50MARKDOWN_SUPPORT       = YES
51TOC_INCLUDE_HEADINGS   = 5
52MARKDOWN_ID_STYLE      = DOXYGEN
53AUTOLINK_SUPPORT       = YES
54BUILTIN_STL_SUPPORT    = NO
55CPP_CLI_SUPPORT        = NO
56SIP_SUPPORT            = NO
57IDL_PROPERTY_SUPPORT   = YES
58DISTRIBUTE_GROUP_DOC   = NO
59GROUP_NESTED_COMPOUNDS = NO
60SUBGROUPING            = YES
61INLINE_GROUPED_CLASSES = NO
62INLINE_SIMPLE_STRUCTS  = NO
63TYPEDEF_HIDES_STRUCT   = NO
64LOOKUP_CACHE_SIZE      = 0
65NUM_PROC_THREADS       = 0
66TIMESTAMP              = NO
67#---------------------------------------------------------------------------
68# Build related configuration options
69#---------------------------------------------------------------------------
70EXTRACT_ALL            = YES
71EXTRACT_PRIVATE        = NO
72EXTRACT_PRIV_VIRTUAL   = NO
73EXTRACT_PACKAGE        = NO
74EXTRACT_STATIC         = NO
75EXTRACT_LOCAL_CLASSES  = NO
76EXTRACT_LOCAL_METHODS  = NO
77EXTRACT_ANON_NSPACES   = NO
78RESOLVE_UNNAMED_PARAMS = YES
79HIDE_UNDOC_MEMBERS     = NO
80HIDE_UNDOC_CLASSES     = NO
81HIDE_FRIEND_COMPOUNDS  = NO
82HIDE_IN_BODY_DOCS      = NO
83INTERNAL_DOCS          = NO
84CASE_SENSE_NAMES       = SYSTEM
85HIDE_SCOPE_NAMES       = NO
86HIDE_COMPOUND_REFERENCE= NO
87SHOW_HEADERFILE        = YES
88SHOW_INCLUDE_FILES     = YES
89SHOW_GROUPED_MEMB_INC  = NO
90FORCE_LOCAL_INCLUDES   = NO
91INLINE_INFO            = YES
92SORT_MEMBER_DOCS       = NO
93SORT_BRIEF_DOCS        = NO
94SORT_MEMBERS_CTORS_1ST = NO
95SORT_GROUP_NAMES       = NO
96SORT_BY_SCOPE_NAME     = NO
97STRICT_PROTO_MATCHING  = YES
98GENERATE_TODOLIST      = YES
99GENERATE_TESTLIST      = YES
100GENERATE_BUGLIST       = YES
101GENERATE_DEPRECATEDLIST= YES
102ENABLED_SECTIONS       =
103MAX_INITIALIZER_LINES  = 30
104SHOW_USED_FILES        = YES
105SHOW_FILES             = YES
106SHOW_NAMESPACES        = YES
107FILE_VERSION_FILTER    =
108LAYOUT_FILE            =
109CITE_BIB_FILES         =
110#---------------------------------------------------------------------------
111# Configuration options related to warning and progress messages
112#---------------------------------------------------------------------------
113QUIET                  = NO
114WARNINGS               = YES
115WARN_IF_UNDOCUMENTED   = YES
116WARN_IF_DOC_ERROR      = YES
117WARN_IF_INCOMPLETE_DOC = YES
118WARN_NO_PARAMDOC       = YES
119WARN_IF_UNDOC_ENUM_VAL = NO
120WARN_AS_ERROR          = NO
121WARN_FORMAT            = "$file:$line: $text"
122WARN_LINE_FORMAT       = "at line $line of file $file"
123WARN_LOGFILE           =
124#---------------------------------------------------------------------------
125# Configuration options related to the input files
126#---------------------------------------------------------------------------
127INPUT                  = @sources@
128INPUT_ENCODING         = UTF-8
129INPUT_FILE_ENCODING    =
130FILE_PATTERNS          =
131RECURSIVE              = YES
132EXCLUDE                =
133EXCLUDE_SYMLINKS       = NO
134EXCLUDE_PATTERNS       =
135EXCLUDE_SYMBOLS        =
136EXAMPLE_PATH           =
137EXAMPLE_PATTERNS       = *
138EXAMPLE_RECURSIVE      = NO
139IMAGE_PATH             =
140INPUT_FILTER           =
141FILTER_PATTERNS        =
142FILTER_SOURCE_FILES    = NO
143FILTER_SOURCE_PATTERNS =
144USE_MDFILE_AS_MAINPAGE =
145FORTRAN_COMMENT_AFTER  = 72
146#---------------------------------------------------------------------------
147# Configuration options related to source browsing
148#---------------------------------------------------------------------------
149SOURCE_BROWSER         = NO
150INLINE_SOURCES         = NO
151STRIP_CODE_COMMENTS    = YES
152REFERENCED_BY_RELATION = NO
153REFERENCES_RELATION    = NO
154REFERENCES_LINK_SOURCE = YES
155SOURCE_TOOLTIPS        = YES
156USE_HTAGS              = NO
157VERBATIM_HEADERS       = YES
158CLANG_ASSISTED_PARSING = NO
159CLANG_ADD_INC_PATHS    = YES
160CLANG_OPTIONS          =
161CLANG_DATABASE_PATH    =
162#---------------------------------------------------------------------------
163# Configuration options related to the alphabetical class index
164#---------------------------------------------------------------------------
165ALPHABETICAL_INDEX     = YES
166IGNORE_PREFIX          =
167#---------------------------------------------------------------------------
168# Configuration options related to the HTML output
169#---------------------------------------------------------------------------
170GENERATE_HTML          = YES
171HTML_OUTPUT            = html
172HTML_FILE_EXTENSION    = .html
173HTML_HEADER            =
174HTML_FOOTER            =
175HTML_STYLESHEET        =
176HTML_EXTRA_STYLESHEET  =
177HTML_EXTRA_FILES       =
178HTML_COLORSTYLE        = AUTO_LIGHT
179HTML_COLORSTYLE_HUE    = 220
180HTML_COLORSTYLE_SAT    = 100
181HTML_COLORSTYLE_GAMMA  = 80
182HTML_DYNAMIC_MENUS     = YES
183HTML_DYNAMIC_SECTIONS  = NO
184HTML_CODE_FOLDING      = YES
185HTML_INDEX_NUM_ENTRIES = 100
186GENERATE_DOCSET        = NO
187DOCSET_FEEDNAME        = "Doxygen generated docs"
188DOCSET_FEEDURL         =
189DOCSET_BUNDLE_ID       = org.openbmc.libpldm
190DOCSET_PUBLISHER_ID    = org.openbmc
191DOCSET_PUBLISHER_NAME  = OpenBMC
192GENERATE_HTMLHELP      = NO
193CHM_FILE               =
194HHC_LOCATION           =
195GENERATE_CHI           = NO
196CHM_INDEX_ENCODING     =
197BINARY_TOC             = NO
198TOC_EXPAND             = NO
199SITEMAP_URL            =
200GENERATE_QHP           = NO
201QCH_FILE               =
202QHP_NAMESPACE          = org.openbmc.libldm
203QHP_VIRTUAL_FOLDER     = doc
204QHP_CUST_FILTER_NAME   =
205QHP_CUST_FILTER_ATTRS  =
206QHP_SECT_FILTER_ATTRS  =
207QHG_LOCATION           =
208GENERATE_ECLIPSEHELP   = NO
209ECLIPSE_DOC_ID         = org.openbmc.libpldm
210DISABLE_INDEX          = NO
211GENERATE_TREEVIEW      = NO
212FULL_SIDEBAR           = NO
213ENUM_VALUES_PER_LINE   = 4
214TREEVIEW_WIDTH         = 250
215EXT_LINKS_IN_WINDOW    = NO
216OBFUSCATE_EMAILS       = YES
217HTML_FORMULA_FORMAT    = png
218FORMULA_FONTSIZE       = 10
219FORMULA_MACROFILE      =
220USE_MATHJAX            = NO
221MATHJAX_VERSION        = MathJax_2
222MATHJAX_FORMAT         = HTML-CSS
223MATHJAX_RELPATH        =
224MATHJAX_EXTENSIONS     =
225MATHJAX_CODEFILE       =
226SEARCHENGINE           = YES
227SERVER_BASED_SEARCH    = NO
228EXTERNAL_SEARCH        = NO
229SEARCHENGINE_URL       =
230SEARCHDATA_FILE        = searchdata.xml
231EXTERNAL_SEARCH_ID     =
232EXTRA_SEARCH_MAPPINGS  =
233#---------------------------------------------------------------------------
234# Configuration options related to the LaTeX output
235#---------------------------------------------------------------------------
236GENERATE_LATEX         = NO
237LATEX_OUTPUT           = latex
238LATEX_CMD_NAME         =
239MAKEINDEX_CMD_NAME     = makeindex
240LATEX_MAKEINDEX_CMD    = makeindex
241COMPACT_LATEX          = NO
242PAPER_TYPE             = a4
243EXTRA_PACKAGES         =
244LATEX_HEADER           =
245LATEX_FOOTER           =
246LATEX_EXTRA_STYLESHEET =
247LATEX_EXTRA_FILES      =
248PDF_HYPERLINKS         = YES
249USE_PDFLATEX           = YES
250LATEX_BATCHMODE        = NO
251LATEX_HIDE_INDICES     = NO
252LATEX_BIB_STYLE        = plain
253LATEX_EMOJI_DIRECTORY  =
254#---------------------------------------------------------------------------
255# Configuration options related to the RTF output
256#---------------------------------------------------------------------------
257GENERATE_RTF           = NO
258RTF_OUTPUT             = rtf
259COMPACT_RTF            = NO
260RTF_HYPERLINKS         = NO
261RTF_STYLESHEET_FILE    =
262RTF_EXTENSIONS_FILE    =
263#---------------------------------------------------------------------------
264# Configuration options related to the man page output
265#---------------------------------------------------------------------------
266GENERATE_MAN           = NO
267MAN_OUTPUT             = man
268MAN_EXTENSION          = .3
269MAN_SUBDIR             =
270MAN_LINKS              = NO
271#---------------------------------------------------------------------------
272# Configuration options related to the XML output
273#---------------------------------------------------------------------------
274GENERATE_XML           = NO
275XML_OUTPUT             = xml
276XML_PROGRAMLISTING     = YES
277XML_NS_MEMB_FILE_SCOPE = NO
278#---------------------------------------------------------------------------
279# Configuration options related to the DOCBOOK output
280#---------------------------------------------------------------------------
281GENERATE_DOCBOOK       = NO
282DOCBOOK_OUTPUT         = docbook
283#---------------------------------------------------------------------------
284# Configuration options for the AutoGen Definitions output
285#---------------------------------------------------------------------------
286GENERATE_AUTOGEN_DEF   = NO
287#---------------------------------------------------------------------------
288# Configuration options related to Sqlite3 output
289#---------------------------------------------------------------------------
290GENERATE_SQLITE3       = NO
291SQLITE3_OUTPUT         = sqlite3
292SQLITE3_RECREATE_DB    = YES
293#---------------------------------------------------------------------------
294# Configuration options related to the Perl module output
295#---------------------------------------------------------------------------
296GENERATE_PERLMOD       = NO
297PERLMOD_LATEX          = NO
298PERLMOD_PRETTY         = YES
299PERLMOD_MAKEVAR_PREFIX =
300#---------------------------------------------------------------------------
301# Configuration options related to the preprocessor
302#---------------------------------------------------------------------------
303ENABLE_PREPROCESSING   = YES
304MACRO_EXPANSION        = NO
305EXPAND_ONLY_PREDEF     = NO
306SEARCH_INCLUDES        = YES
307INCLUDE_PATH           =
308INCLUDE_FILE_PATTERNS  =
309PREDEFINED             =
310EXPAND_AS_DEFINED      =
311SKIP_FUNCTION_MACROS   = YES
312#---------------------------------------------------------------------------
313# Configuration options related to external references
314#---------------------------------------------------------------------------
315TAGFILES               =
316GENERATE_TAGFILE       =
317ALLEXTERNALS           = NO
318EXTERNAL_GROUPS        = YES
319EXTERNAL_PAGES         = YES
320#---------------------------------------------------------------------------
321# Configuration options related to diagram generator tools
322#---------------------------------------------------------------------------
323HIDE_UNDOC_RELATIONS   = YES
324HAVE_DOT               = YES
325DOT_NUM_THREADS        = 0
326DOT_COMMON_ATTR        = "fontname=Helvetica,fontsize=10"
327DOT_EDGE_ATTR          = "labelfontname=Helvetica,labelfontsize=10"
328DOT_NODE_ATTR          = "shape=box,height=0.2,width=0.4"
329DOT_FONTPATH           =
330CLASS_GRAPH            = YES
331COLLABORATION_GRAPH    = YES
332GROUP_GRAPHS           = YES
333UML_LOOK               = NO
334UML_LIMIT_NUM_FIELDS   = 10
335DOT_UML_DETAILS        = NO
336DOT_WRAP_THRESHOLD     = 17
337TEMPLATE_RELATIONS     = NO
338INCLUDE_GRAPH          = YES
339INCLUDED_BY_GRAPH      = YES
340CALL_GRAPH             = NO
341CALLER_GRAPH           = NO
342GRAPHICAL_HIERARCHY    = YES
343DIRECTORY_GRAPH        = YES
344DIR_GRAPH_MAX_DEPTH    = 1
345DOT_IMAGE_FORMAT       = png
346INTERACTIVE_SVG        = NO
347DOT_PATH               =
348DOTFILE_DIRS           =
349DIA_PATH               =
350DIAFILE_DIRS           =
351PLANTUML_JAR_PATH      =
352PLANTUML_CFG_FILE      =
353PLANTUML_INCLUDE_PATH  =
354DOT_GRAPH_MAX_NODES    = 50
355MAX_DOT_GRAPH_DEPTH    = 0
356DOT_MULTI_TARGETS      = NO
357GENERATE_LEGEND        = YES
358DOT_CLEANUP            = YES
359MSCGEN_TOOL            =
360MSCFILE_DIRS           =
361