xref: /freebsd/crypto/heimdal/doc/doxytmpl.dxy (revision 2008043f386721d58158e37e0d7e50df8095942d)
1#---------------------------------------------------------------------------
2# Project related configuration options
3#---------------------------------------------------------------------------
4DOXYFILE_ENCODING      = UTF-8
5CREATE_SUBDIRS         = NO
6OUTPUT_LANGUAGE        = English
7BRIEF_MEMBER_DESC      = YES
8REPEAT_BRIEF           = YES
9ABBREVIATE_BRIEF       = "The $name class " \
10                         "The $name widget " \
11                         "The $name file " \
12                         is \
13                         provides \
14                         specifies \
15                         contains \
16                         represents \
17                         a \
18                         an \
19                         the
20ALWAYS_DETAILED_SEC    = NO
21INLINE_INHERITED_MEMB  = NO
22FULL_PATH_NAMES        = YES
23STRIP_FROM_PATH        = /Applications/
24STRIP_FROM_INC_PATH    =
25SHORT_NAMES            = NO
26JAVADOC_AUTOBRIEF      = NO
27QT_AUTOBRIEF           = NO
28MULTILINE_CPP_IS_BRIEF = NO
29DETAILS_AT_TOP         = NO
30INHERIT_DOCS           = YES
31SEPARATE_MEMBER_PAGES  = NO
32TAB_SIZE               = 8
33ALIASES                =
34OPTIMIZE_OUTPUT_FOR_C  = YES
35OPTIMIZE_OUTPUT_JAVA   = NO
36BUILTIN_STL_SUPPORT    = NO
37CPP_CLI_SUPPORT        = NO
38DISTRIBUTE_GROUP_DOC   = NO
39SUBGROUPING            = YES
40#---------------------------------------------------------------------------
41# Build related configuration options
42#---------------------------------------------------------------------------
43EXTRACT_ALL            = NO
44EXTRACT_PRIVATE        = NO
45EXTRACT_STATIC         = NO
46EXTRACT_LOCAL_CLASSES  = YES
47EXTRACT_LOCAL_METHODS  = NO
48EXTRACT_ANON_NSPACES   = NO
49HIDE_UNDOC_MEMBERS     = YES
50HIDE_UNDOC_CLASSES     = YES
51HIDE_FRIEND_COMPOUNDS  = NO
52HIDE_IN_BODY_DOCS      = NO
53INTERNAL_DOCS          = NO
54CASE_SENSE_NAMES       = NO
55HIDE_SCOPE_NAMES       = NO
56SHOW_INCLUDE_FILES     = YES
57INLINE_INFO            = YES
58SORT_MEMBER_DOCS       = YES
59SORT_BRIEF_DOCS        = NO
60SORT_BY_SCOPE_NAME     = NO
61GENERATE_TODOLIST      = YES
62GENERATE_TESTLIST      = YES
63GENERATE_BUGLIST       = YES
64GENERATE_DEPRECATEDLIST= YES
65ENABLED_SECTIONS       =
66MAX_INITIALIZER_LINES  = 30
67SHOW_USED_FILES        = YES
68SHOW_DIRECTORIES       = NO
69FILE_VERSION_FILTER    =
70#---------------------------------------------------------------------------
71# configuration options related to warning and progress messages
72#---------------------------------------------------------------------------
73QUIET                  = YES
74WARNINGS               = YES
75WARN_IF_DOC_ERROR      = YES
76WARN_NO_PARAMDOC       = YES
77WARN_FORMAT            = "$file:$line: $text "
78WARN_LOGFILE           =
79#---------------------------------------------------------------------------
80# configuration options related to the input files
81#---------------------------------------------------------------------------
82INPUT_ENCODING         = UTF-8
83FILE_PATTERNS          = *.c \
84                         *.cc \
85                         *.cxx \
86                         *.cpp \
87                         *.c++ \
88                         *.d \
89                         *.java \
90                         *.ii \
91                         *.ixx \
92                         *.ipp \
93                         *.i++ \
94                         *.inl \
95                         *.h \
96                         *.hh \
97                         *.hxx \
98                         *.hpp \
99                         *.h++ \
100                         *.idl \
101                         *.odl \
102                         *.cs \
103                         *.php \
104                         *.php3 \
105                         *.inc \
106                         *.m \
107                         *.mm \
108                         *.dox \
109                         *.py
110RECURSIVE              = YES
111EXCLUDE                =
112EXCLUDE_SYMLINKS       = NO
113EXCLUDE_PATTERNS       = */.svn
114EXCLUDE_SYMBOLS        =
115EXAMPLE_PATTERNS       = *
116EXAMPLE_RECURSIVE      = NO
117IMAGE_PATH             =
118INPUT_FILTER           =
119FILTER_PATTERNS        =
120FILTER_SOURCE_FILES    = NO
121#---------------------------------------------------------------------------
122# configuration options related to source browsing
123#---------------------------------------------------------------------------
124SOURCE_BROWSER         = NO
125INLINE_SOURCES         = NO
126STRIP_CODE_COMMENTS    = YES
127REFERENCED_BY_RELATION = NO
128REFERENCES_RELATION    = NO
129REFERENCES_LINK_SOURCE = YES
130USE_HTAGS              = NO
131VERBATIM_HEADERS       = NO
132#---------------------------------------------------------------------------
133# configuration options related to the alphabetical class index
134#---------------------------------------------------------------------------
135ALPHABETICAL_INDEX     = NO
136COLS_IN_ALPHA_INDEX    = 5
137IGNORE_PREFIX          =
138#---------------------------------------------------------------------------
139# configuration options related to the HTML output
140#---------------------------------------------------------------------------
141GENERATE_HTML          = YES
142HTML_OUTPUT            = html
143HTML_FILE_EXTENSION    = .html
144HTML_STYLESHEET        =
145HTML_ALIGN_MEMBERS     = YES
146GENERATE_HTMLHELP      = NO
147HTML_DYNAMIC_SECTIONS  = NO
148CHM_FILE               =
149HHC_LOCATION           =
150GENERATE_CHI           = NO
151BINARY_TOC             = NO
152TOC_EXPAND             = NO
153DISABLE_INDEX          = NO
154ENUM_VALUES_PER_LINE   = 4
155GENERATE_TREEVIEW      = NO
156TREEVIEW_WIDTH         = 250
157#---------------------------------------------------------------------------
158# configuration options related to the LaTeX output
159#---------------------------------------------------------------------------
160GENERATE_LATEX         = NO
161LATEX_OUTPUT           = latex
162LATEX_CMD_NAME         = latex
163MAKEINDEX_CMD_NAME     = makeindex
164COMPACT_LATEX          = NO
165PAPER_TYPE             = a4wide
166EXTRA_PACKAGES         =
167LATEX_HEADER           =
168PDF_HYPERLINKS         = NO
169USE_PDFLATEX           = NO
170LATEX_BATCHMODE        = NO
171LATEX_HIDE_INDICES     = NO
172#---------------------------------------------------------------------------
173# configuration options related to the RTF output
174#---------------------------------------------------------------------------
175GENERATE_RTF           = NO
176RTF_OUTPUT             = rtf
177COMPACT_RTF            = NO
178RTF_HYPERLINKS         = NO
179RTF_STYLESHEET_FILE    =
180RTF_EXTENSIONS_FILE    =
181#---------------------------------------------------------------------------
182# configuration options related to the man page output
183#---------------------------------------------------------------------------
184GENERATE_MAN           = YES
185MAN_OUTPUT             = man
186MAN_EXTENSION          = .3
187MAN_LINKS              = YES
188#---------------------------------------------------------------------------
189# configuration options related to the XML output
190#---------------------------------------------------------------------------
191GENERATE_XML           = NO
192XML_OUTPUT             = xml
193XML_SCHEMA             =
194XML_DTD                =
195XML_PROGRAMLISTING     = YES
196#---------------------------------------------------------------------------
197# configuration options for the AutoGen Definitions output
198#---------------------------------------------------------------------------
199GENERATE_AUTOGEN_DEF   = NO
200#---------------------------------------------------------------------------
201# configuration options related to the Perl module output
202#---------------------------------------------------------------------------
203GENERATE_PERLMOD       = NO
204PERLMOD_LATEX          = NO
205PERLMOD_PRETTY         = YES
206PERLMOD_MAKEVAR_PREFIX =
207#---------------------------------------------------------------------------
208# Configuration options related to the preprocessor
209#---------------------------------------------------------------------------
210ENABLE_PREPROCESSING   = YES
211MACRO_EXPANSION        = NO
212EXPAND_ONLY_PREDEF     = NO
213SEARCH_INCLUDES        = YES
214INCLUDE_PATH           =
215INCLUDE_FILE_PATTERNS  =
216PREDEFINED             =
217EXPAND_AS_DEFINED      =
218SKIP_FUNCTION_MACROS   = YES
219#---------------------------------------------------------------------------
220# Configuration::additions related to external references
221#---------------------------------------------------------------------------
222TAGFILES               =
223GENERATE_TAGFILE       =
224ALLEXTERNALS           = NO
225EXTERNAL_GROUPS        = YES
226#---------------------------------------------------------------------------
227# Configuration options related to the dot tool
228#---------------------------------------------------------------------------
229CLASS_DIAGRAMS         = NO
230MSCGEN_PATH            = /Applications/Doxygen.app/Contents/Resources/
231HIDE_UNDOC_RELATIONS   = YES
232HAVE_DOT               = YES
233CLASS_GRAPH            = YES
234COLLABORATION_GRAPH    = YES
235GROUP_GRAPHS           = YES
236UML_LOOK               = NO
237TEMPLATE_RELATIONS     = NO
238INCLUDE_GRAPH          = YES
239INCLUDED_BY_GRAPH      = YES
240CALL_GRAPH             = NO
241CALLER_GRAPH           = NO
242GRAPHICAL_HIERARCHY    = YES
243DIRECTORY_GRAPH        = YES
244DOT_IMAGE_FORMAT       = png
245DOT_PATH               = /Applications/Doxygen.app/Contents/Resources/
246DOTFILE_DIRS           =
247DOT_GRAPH_MAX_NODES    = 50
248MAX_DOT_GRAPH_DEPTH    = 1000
249DOT_TRANSPARENT        = NO
250DOT_MULTI_TARGETS      = NO
251GENERATE_LEGEND        = YES
252DOT_CLEANUP            = YES
253#---------------------------------------------------------------------------
254# Configuration::additions related to the search engine
255#---------------------------------------------------------------------------
256SEARCHENGINE           = NO
257