]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - docs/Doxyfile
Update the module descriptions.
[user/henk/code/inspircd.git] / docs / Doxyfile
1 DOXYFILE_ENCODING      = UTF-8
2 PROJECT_NAME           = InspIRCd
3 PROJECT_NUMBER         = 3.0
4 PROJECT_BRIEF          =
5 PROJECT_LOGO           =
6 OUTPUT_DIRECTORY       = docs/doxygen
7 CREATE_SUBDIRS         = NO
8 ALLOW_UNICODE_NAMES    = NO
9 OUTPUT_LANGUAGE        = English
10 OUTPUT_TEXT_DIRECTION  = None
11 BRIEF_MEMBER_DESC      = YES
12 REPEAT_BRIEF           = YES
13 ABBREVIATE_BRIEF       =
14 ALWAYS_DETAILED_SEC    = NO
15 INLINE_INHERITED_MEMB  = NO
16 FULL_PATH_NAMES        = YES
17 STRIP_FROM_PATH        =
18 STRIP_FROM_INC_PATH    =
19 SHORT_NAMES            = NO
20 JAVADOC_AUTOBRIEF      = NO
21 JAVADOC_BANNER         = NO
22 QT_AUTOBRIEF           = NO
23 MULTILINE_CPP_IS_BRIEF = NO
24 INHERIT_DOCS           = YES
25 SEPARATE_MEMBER_PAGES  = NO
26 TAB_SIZE               = 8
27 ALIASES                =
28 TCL_SUBST              =
29 OPTIMIZE_OUTPUT_FOR_C  = NO
30 OPTIMIZE_OUTPUT_JAVA   = NO
31 OPTIMIZE_FOR_FORTRAN   = NO
32 OPTIMIZE_OUTPUT_VHDL   = NO
33 OPTIMIZE_OUTPUT_SLICE  = NO
34 EXTENSION_MAPPING      =
35 MARKDOWN_SUPPORT       = YES
36 TOC_INCLUDE_HEADINGS   = 5
37 AUTOLINK_SUPPORT       = YES
38 BUILTIN_STL_SUPPORT    = YES
39 CPP_CLI_SUPPORT        = NO
40 SIP_SUPPORT            = NO
41 IDL_PROPERTY_SUPPORT   = YES
42 DISTRIBUTE_GROUP_DOC   = NO
43 GROUP_NESTED_COMPOUNDS = NO
44 SUBGROUPING            = YES
45 INLINE_GROUPED_CLASSES = NO
46 INLINE_SIMPLE_STRUCTS  = NO
47 TYPEDEF_HIDES_STRUCT   = NO
48 LOOKUP_CACHE_SIZE      = 0
49 EXTRACT_ALL            = NO
50 EXTRACT_PRIVATE        = NO
51 EXTRACT_PRIV_VIRTUAL   = NO
52 EXTRACT_PACKAGE        = NO
53 EXTRACT_STATIC         = NO
54 EXTRACT_LOCAL_CLASSES  = YES
55 EXTRACT_LOCAL_METHODS  = NO
56 EXTRACT_ANON_NSPACES   = NO
57 HIDE_UNDOC_MEMBERS     = NO
58 HIDE_UNDOC_CLASSES     = NO
59 HIDE_FRIEND_COMPOUNDS  = NO
60 HIDE_IN_BODY_DOCS      = NO
61 INTERNAL_DOCS          = NO
62 CASE_SENSE_NAMES       = NO
63 HIDE_SCOPE_NAMES       = NO
64 HIDE_COMPOUND_REFERENCE= NO
65 SHOW_INCLUDE_FILES     = YES
66 SHOW_GROUPED_MEMB_INC  = NO
67 FORCE_LOCAL_INCLUDES   = NO
68 INLINE_INFO            = YES
69 SORT_MEMBER_DOCS       = YES
70 SORT_BRIEF_DOCS        = NO
71 SORT_MEMBERS_CTORS_1ST = NO
72 SORT_GROUP_NAMES       = NO
73 SORT_BY_SCOPE_NAME     = NO
74 STRICT_PROTO_MATCHING  = NO
75 GENERATE_TODOLIST      = YES
76 GENERATE_TESTLIST      = YES
77 GENERATE_BUGLIST       = YES
78 GENERATE_DEPRECATEDLIST= YES
79 ENABLED_SECTIONS       =
80 MAX_INITIALIZER_LINES  = 30
81 SHOW_USED_FILES        = YES
82 SHOW_FILES             = YES
83 SHOW_NAMESPACES        = YES
84 FILE_VERSION_FILTER    =
85 LAYOUT_FILE            =
86 CITE_BIB_FILES         =
87 QUIET                  = NO
88 WARNINGS               = NO
89 WARN_IF_UNDOCUMENTED   = NO
90 WARN_IF_DOC_ERROR      = YES
91 WARN_NO_PARAMDOC       = NO
92 WARN_AS_ERROR          = NO
93 WARN_FORMAT            = "$file:$line: $text"
94 WARN_LOGFILE           =
95 INPUT                  =
96 INPUT_ENCODING         = UTF-8
97 FILE_PATTERNS          =
98 RECURSIVE              = YES
99 EXCLUDE                =
100 EXCLUDE_SYMLINKS       = YES
101 EXCLUDE_PATTERNS       = */.git/* \
102                          */doxygen/* \
103                          */coremods/* \
104                          */modules/* \
105                          */vendor/*
106 EXCLUDE_SYMBOLS        =
107 EXAMPLE_PATH           =
108 EXAMPLE_PATTERNS       =
109 EXAMPLE_RECURSIVE      = NO
110 IMAGE_PATH             =
111 INPUT_FILTER           =
112 FILTER_PATTERNS        =
113 FILTER_SOURCE_FILES    = NO
114 FILTER_SOURCE_PATTERNS =
115 USE_MDFILE_AS_MAINPAGE = README.md
116 SOURCE_BROWSER         = NO
117 INLINE_SOURCES         = NO
118 STRIP_CODE_COMMENTS    = YES
119 REFERENCED_BY_RELATION = NO
120 REFERENCES_RELATION    = NO
121 REFERENCES_LINK_SOURCE = YES
122 SOURCE_TOOLTIPS        = YES
123 USE_HTAGS              = NO
124 VERBATIM_HEADERS       = YES
125 ALPHABETICAL_INDEX     = YES
126 COLS_IN_ALPHA_INDEX    = 5
127 IGNORE_PREFIX          =
128 GENERATE_HTML          = YES
129 HTML_OUTPUT            = html
130 HTML_FILE_EXTENSION    = .html
131 HTML_HEADER            =
132 HTML_FOOTER            =
133 HTML_STYLESHEET        =
134 HTML_EXTRA_STYLESHEET  =
135 HTML_EXTRA_FILES       =
136 HTML_COLORSTYLE_HUE    = 220
137 HTML_COLORSTYLE_SAT    = 100
138 HTML_COLORSTYLE_GAMMA  = 80
139 HTML_TIMESTAMP         = NO
140 HTML_DYNAMIC_MENUS     = YES
141 HTML_DYNAMIC_SECTIONS  = NO
142 HTML_INDEX_NUM_ENTRIES = 100
143 GENERATE_DOCSET        = YES
144 DOCSET_FEEDNAME        = "Doxygen generated documentation"
145 DOCSET_BUNDLE_ID       = org.doxygen.Project
146 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
147 DOCSET_PUBLISHER_NAME  = Publisher
148 GENERATE_HTMLHELP      = NO
149 CHM_FILE               =
150 HHC_LOCATION           =
151 GENERATE_CHI           = NO
152 CHM_INDEX_ENCODING     =
153 BINARY_TOC             = NO
154 TOC_EXPAND             = NO
155 GENERATE_QHP           = NO
156 QCH_FILE               =
157 QHP_NAMESPACE          = org.doxygen.Project
158 QHP_VIRTUAL_FOLDER     = doc
159 QHP_CUST_FILTER_NAME   =
160 QHP_CUST_FILTER_ATTRS  =
161 QHP_SECT_FILTER_ATTRS  =
162 QHG_LOCATION           =
163 GENERATE_ECLIPSEHELP   = NO
164 ECLIPSE_DOC_ID         = org.doxygen.Project
165 DISABLE_INDEX          = NO
166 GENERATE_TREEVIEW      = NO
167 ENUM_VALUES_PER_LINE   = 4
168 TREEVIEW_WIDTH         = 250
169 EXT_LINKS_IN_WINDOW    = NO
170 FORMULA_FONTSIZE       = 10
171 FORMULA_TRANSPARENT    = YES
172 USE_MATHJAX            = NO
173 MATHJAX_FORMAT         = HTML-CSS
174 MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
175 MATHJAX_EXTENSIONS     =
176 MATHJAX_CODEFILE       =
177 SEARCHENGINE           = YES
178 SERVER_BASED_SEARCH    = NO
179 EXTERNAL_SEARCH        = NO
180 SEARCHENGINE_URL       =
181 SEARCHDATA_FILE        = searchdata.xml
182 EXTERNAL_SEARCH_ID     =
183 EXTRA_SEARCH_MAPPINGS  =
184 GENERATE_LATEX         = NO
185 LATEX_OUTPUT           = latex
186 LATEX_CMD_NAME         = latex
187 MAKEINDEX_CMD_NAME     = makeindex
188 LATEX_MAKEINDEX_CMD    = makeindex
189 COMPACT_LATEX          = NO
190 PAPER_TYPE             = a4
191 EXTRA_PACKAGES         =
192 LATEX_HEADER           =
193 LATEX_FOOTER           =
194 LATEX_EXTRA_STYLESHEET =
195 LATEX_EXTRA_FILES      =
196 PDF_HYPERLINKS         = YES
197 USE_PDFLATEX           = YES
198 LATEX_BATCHMODE        = NO
199 LATEX_HIDE_INDICES     = NO
200 LATEX_SOURCE_CODE      = NO
201 LATEX_BIB_STYLE        = plain
202 LATEX_TIMESTAMP        = NO
203 LATEX_EMOJI_DIRECTORY  =
204 GENERATE_RTF           = NO
205 RTF_OUTPUT             = rtf
206 COMPACT_RTF            = NO
207 RTF_HYPERLINKS         = NO
208 RTF_STYLESHEET_FILE    =
209 RTF_EXTENSIONS_FILE    =
210 RTF_SOURCE_CODE        = NO
211 GENERATE_MAN           = NO
212 MAN_OUTPUT             = man
213 MAN_EXTENSION          = .3
214 MAN_SUBDIR             =
215 MAN_LINKS              = NO
216 GENERATE_XML           = NO
217 XML_OUTPUT             = xml
218 XML_PROGRAMLISTING     = YES
219 XML_NS_MEMB_FILE_SCOPE = NO
220 GENERATE_DOCBOOK       = NO
221 DOCBOOK_OUTPUT         = docbook
222 DOCBOOK_PROGRAMLISTING = NO
223 GENERATE_AUTOGEN_DEF   = NO
224 GENERATE_PERLMOD       = NO
225 PERLMOD_LATEX          = NO
226 PERLMOD_PRETTY         = YES
227 PERLMOD_MAKEVAR_PREFIX =
228 ENABLE_PREPROCESSING   = YES
229 MACRO_EXPANSION        = YES
230 EXPAND_ONLY_PREDEF     = NO
231 SEARCH_INCLUDES        = YES
232 INCLUDE_PATH           =
233 INCLUDE_FILE_PATTERNS  =
234 PREDEFINED             = CoreExport=/**/ \
235                          INSPIRCD_INTRUSIVE_LIST_NAME=intrusive_list
236 EXPAND_AS_DEFINED      =
237 SKIP_FUNCTION_MACROS   = YES
238 TAGFILES               =
239 GENERATE_TAGFILE       =
240 ALLEXTERNALS           = NO
241 EXTERNAL_GROUPS        = YES
242 EXTERNAL_PAGES         = YES
243 CLASS_DIAGRAMS         = YES
244 DIA_PATH               =
245 HIDE_UNDOC_RELATIONS   = YES
246 HAVE_DOT               = NO
247 DOT_NUM_THREADS        = 0
248 DOT_FONTNAME           = Helvetica
249 DOT_FONTSIZE           = 10
250 DOT_FONTPATH           =
251 CLASS_GRAPH            = YES
252 COLLABORATION_GRAPH    = YES
253 GROUP_GRAPHS           = YES
254 UML_LOOK               = NO
255 UML_LIMIT_NUM_FIELDS   = 10
256 TEMPLATE_RELATIONS     = NO
257 INCLUDE_GRAPH          = YES
258 INCLUDED_BY_GRAPH      = YES
259 CALL_GRAPH             = NO
260 CALLER_GRAPH           = NO
261 GRAPHICAL_HIERARCHY    = YES
262 DIRECTORY_GRAPH        = YES
263 DOT_IMAGE_FORMAT       = png
264 INTERACTIVE_SVG        = NO
265 DOT_PATH               =
266 DOTFILE_DIRS           =
267 MSCFILE_DIRS           =
268 DIAFILE_DIRS           =
269 PLANTUML_JAR_PATH      =
270 PLANTUML_CFG_FILE      =
271 PLANTUML_INCLUDE_PATH  =
272 DOT_GRAPH_MAX_NODES    = 50
273 MAX_DOT_GRAPH_DEPTH    = 0
274 DOT_TRANSPARENT        = NO
275 DOT_MULTI_TARGETS      = NO
276 GENERATE_LEGEND        = YES
277 DOT_CLEANUP            = YES