Add a make target, such that 'make doxygen' works (both for in-tree and
out-of-tree builds). This now generates the doxygen in doc/doxygen/,
rather than in doxygen/.
While doing so, instead of genering docs with full path names (e.g.
/home/steffan/dev/openvpn/src/openvpn/crypto.h), use a relative path wrt
the project root (e.g. src/openvpn/crypto.h) in the generated
documentation. This makes the generated doxygen easier to read.
Signed-off-by: Steffan Karger <steffan.karger@fox-it.com>
Acked-by: Gert Doering <gert@greenie.muc.de>
Message-Id: <1510143174-15248-1-git-send-email-steffan.karger@fox-it.com>
URL: https://www.mail-archive.com/search?l=mid&q=1510143174-15248-1-git-send-email-steffan.karger@fox-it.com
Signed-off-by: Gert Doering <gert@greenie.muc.de>
... | ... |
@@ -34,7 +34,6 @@ config.sub |
34 | 34 |
configure |
35 | 35 |
configure.h |
36 | 36 |
depcomp |
37 |
-doxygen/ |
|
38 | 37 |
stamp-h1 |
39 | 38 |
install-sh |
40 | 39 |
missing |
... | ... |
@@ -51,6 +50,8 @@ msvc-env-local.bat |
51 | 51 |
config-msvc-local.h |
52 | 52 |
config-msvc-version.h |
53 | 53 |
doc/openvpn.8.html |
54 |
+/doc/doxygen/html/ |
|
55 |
+/doc/doxygen/latex/ |
|
54 | 56 |
distro/rpm/openvpn.spec |
55 | 57 |
distro/systemd/*.service |
56 | 58 |
sample/sample-keys/sample-ca/ |
... | ... |
@@ -46,7 +46,7 @@ EXTRA_DIST = \ |
46 | 46 |
contrib \ |
47 | 47 |
debug |
48 | 48 |
|
49 |
-.PHONY: config-version.h |
|
49 |
+.PHONY: config-version.h doxygen |
|
50 | 50 |
|
51 | 51 |
if GIT_CHECKOUT |
52 | 52 |
BUILT_SOURCES = \ |
... | ... |
@@ -96,3 +96,6 @@ config-version.h: |
96 | 96 |
else \ |
97 | 97 |
rm -f config-version.h.tmp; \ |
98 | 98 |
fi |
99 |
+ |
|
100 |
+doxygen: |
|
101 |
+ $(MAKE) -C doc/doxygen doxygen |
... | ... |
@@ -1420,6 +1420,9 @@ AC_CONFIG_FILES([ |
1420 | 1420 |
distro/rpm/Makefile |
1421 | 1421 |
distro/rpm/openvpn.spec |
1422 | 1422 |
distro/systemd/Makefile |
1423 |
+ doc/Makefile |
|
1424 |
+ doc/doxygen/Makefile |
|
1425 |
+ doc/doxygen/openvpn.doxyfile |
|
1423 | 1426 |
include/Makefile |
1424 | 1427 |
src/Makefile |
1425 | 1428 |
src/compat/Makefile |
... | ... |
@@ -1436,7 +1439,6 @@ AC_CONFIG_FILES([ |
1436 | 1436 |
tests/unit_tests/plugins/auth-pam/Makefile |
1437 | 1437 |
vendor/Makefile |
1438 | 1438 |
sample/Makefile |
1439 |
- doc/Makefile |
|
1440 | 1439 |
]) |
1441 | 1440 |
AC_CONFIG_FILES([tests/t_client.sh], [chmod +x tests/t_client.sh]) |
1442 | 1441 |
AC_OUTPUT |
20 | 22 |
new file mode 100644 |
... | ... |
@@ -0,0 +1,21 @@ |
0 |
+# |
|
1 |
+# OpenVPN -- An application to securely tunnel IP networks |
|
2 |
+# over a single UDP port, with support for SSL/TLS-based |
|
3 |
+# session authentication and key exchange, |
|
4 |
+# packet encryption, packet authentication, and |
|
5 |
+# packet compression. |
|
6 |
+# |
|
7 |
+# Copyright (C) 2017 Fox-IT B.V. <openvpn@fox-it.com> |
|
8 |
+# |
|
9 |
+ |
|
10 |
+MAINTAINERCLEANFILES = \ |
|
11 |
+ $(srcdir)/Makefile.in |
|
12 |
+ |
|
13 |
+DISTCLEANFILES = openvpn.doxyfile |
|
14 |
+ |
|
15 |
+.PHONY: doxygen |
|
16 |
+doxygen: openvpn.doxyfile |
|
17 |
+ doxygen openvpn.doxyfile |
|
18 |
+ |
|
19 |
+clean-local: |
|
20 |
+ -rm -rf html latex |
0 | 21 |
deleted file mode 100644 |
... | ... |
@@ -1,279 +0,0 @@ |
1 |
-# Doxyfile 1.5.5 |
|
2 |
- |
|
3 |
-#--------------------------------------------------------------------------- |
|
4 |
-# Project related configuration options |
|
5 |
-#--------------------------------------------------------------------------- |
|
6 |
-DOXYFILE_ENCODING = UTF-8 |
|
7 |
-PROJECT_NAME = "OpenVPN" |
|
8 |
-PROJECT_NUMBER = |
|
9 |
-OUTPUT_DIRECTORY = doxygen |
|
10 |
-CREATE_SUBDIRS = NO |
|
11 |
-OUTPUT_LANGUAGE = English |
|
12 |
-BRIEF_MEMBER_DESC = YES |
|
13 |
-REPEAT_BRIEF = YES |
|
14 |
-ABBREVIATE_BRIEF = "The $name class" \ |
|
15 |
- "The $name widget" \ |
|
16 |
- "The $name file" \ |
|
17 |
- is \ |
|
18 |
- provides \ |
|
19 |
- specifies \ |
|
20 |
- contains \ |
|
21 |
- represents \ |
|
22 |
- a \ |
|
23 |
- an \ |
|
24 |
- the |
|
25 |
-ALWAYS_DETAILED_SEC = NO |
|
26 |
-INLINE_INHERITED_MEMB = NO |
|
27 |
-FULL_PATH_NAMES = YES |
|
28 |
-STRIP_FROM_PATH = "" |
|
29 |
-STRIP_FROM_INC_PATH = |
|
30 |
-SHORT_NAMES = NO |
|
31 |
-JAVADOC_AUTOBRIEF = YES # NO |
|
32 |
-QT_AUTOBRIEF = NO |
|
33 |
-MULTILINE_CPP_IS_BRIEF = NO |
|
34 |
-DETAILS_AT_TOP = NO |
|
35 |
-INHERIT_DOCS = YES |
|
36 |
-SEPARATE_MEMBER_PAGES = NO |
|
37 |
-TAB_SIZE = 8 |
|
38 |
-ALIASES = |
|
39 |
-OPTIMIZE_OUTPUT_FOR_C = YES |
|
40 |
-OPTIMIZE_OUTPUT_JAVA = NO |
|
41 |
-OPTIMIZE_FOR_FORTRAN = NO |
|
42 |
-OPTIMIZE_OUTPUT_VHDL = NO |
|
43 |
-BUILTIN_STL_SUPPORT = NO |
|
44 |
-CPP_CLI_SUPPORT = NO |
|
45 |
-SIP_SUPPORT = NO |
|
46 |
-DISTRIBUTE_GROUP_DOC = NO |
|
47 |
-SUBGROUPING = YES |
|
48 |
-TYPEDEF_HIDES_STRUCT = NO |
|
49 |
-#--------------------------------------------------------------------------- |
|
50 |
-# Build related configuration options |
|
51 |
-#--------------------------------------------------------------------------- |
|
52 |
-EXTRACT_ALL = YES |
|
53 |
-EXTRACT_PRIVATE = YES |
|
54 |
-EXTRACT_STATIC = YES |
|
55 |
-EXTRACT_LOCAL_CLASSES = YES |
|
56 |
-EXTRACT_LOCAL_METHODS = YES |
|
57 |
-EXTRACT_ANON_NSPACES = YES |
|
58 |
-HIDE_UNDOC_MEMBERS = NO |
|
59 |
-HIDE_UNDOC_CLASSES = NO |
|
60 |
-HIDE_FRIEND_COMPOUNDS = NO |
|
61 |
-HIDE_IN_BODY_DOCS = NO |
|
62 |
-INTERNAL_DOCS = NO |
|
63 |
-CASE_SENSE_NAMES = NO |
|
64 |
-HIDE_SCOPE_NAMES = NO |
|
65 |
-SHOW_INCLUDE_FILES = YES |
|
66 |
-INLINE_INFO = YES |
|
67 |
-SORT_MEMBER_DOCS = YES |
|
68 |
-SORT_BRIEF_DOCS = NO |
|
69 |
-SORT_GROUP_NAMES = NO |
|
70 |
-SORT_BY_SCOPE_NAME = NO |
|
71 |
-GENERATE_TODOLIST = YES |
|
72 |
-GENERATE_TESTLIST = YES |
|
73 |
-GENERATE_BUGLIST = YES |
|
74 |
-GENERATE_DEPRECATEDLIST= YES |
|
75 |
-ENABLED_SECTIONS = |
|
76 |
-MAX_INITIALIZER_LINES = 30 |
|
77 |
-SHOW_USED_FILES = YES |
|
78 |
-SHOW_DIRECTORIES = NO |
|
79 |
-FILE_VERSION_FILTER = |
|
80 |
-#--------------------------------------------------------------------------- |
|
81 |
-# configuration options related to warning and progress messages |
|
82 |
-#--------------------------------------------------------------------------- |
|
83 |
-QUIET = NO |
|
84 |
-WARNINGS = YES |
|
85 |
-WARN_IF_UNDOCUMENTED = YES |
|
86 |
-WARN_IF_DOC_ERROR = YES |
|
87 |
-WARN_NO_PARAMDOC = NO |
|
88 |
-WARN_FORMAT = "$file:$line: $text" |
|
89 |
-WARN_LOGFILE = |
|
90 |
-#--------------------------------------------------------------------------- |
|
91 |
-# configuration options related to the input files |
|
92 |
-#--------------------------------------------------------------------------- |
|
93 |
-INPUT = . |
|
94 |
-INPUT_ENCODING = UTF-8 |
|
95 |
-FILE_PATTERNS = *.c \ |
|
96 |
- *.cc \ |
|
97 |
- *.cxx \ |
|
98 |
- *.cpp \ |
|
99 |
- *.c++ \ |
|
100 |
- *.d \ |
|
101 |
- *.java \ |
|
102 |
- *.ii \ |
|
103 |
- *.ixx \ |
|
104 |
- *.ipp \ |
|
105 |
- *.i++ \ |
|
106 |
- *.inl \ |
|
107 |
- *.h \ |
|
108 |
- *.hh \ |
|
109 |
- *.hxx \ |
|
110 |
- *.hpp \ |
|
111 |
- *.h++ \ |
|
112 |
- *.idl \ |
|
113 |
- *.odl \ |
|
114 |
- *.cs \ |
|
115 |
- *.php \ |
|
116 |
- *.php3 \ |
|
117 |
- *.inc \ |
|
118 |
- *.m \ |
|
119 |
- *.mm \ |
|
120 |
- *.dox \ |
|
121 |
- *.py \ |
|
122 |
- *.f90 \ |
|
123 |
- *.f \ |
|
124 |
- *.vhd \ |
|
125 |
- *.vhdl |
|
126 |
-RECURSIVE = YES |
|
127 |
-EXCLUDE = |
|
128 |
-EXCLUDE_SYMLINKS = NO |
|
129 |
-EXCLUDE_PATTERNS = |
|
130 |
-EXCLUDE_SYMBOLS = |
|
131 |
-EXAMPLE_PATH = |
|
132 |
-EXAMPLE_PATTERNS = * |
|
133 |
-EXAMPLE_RECURSIVE = NO |
|
134 |
-IMAGE_PATH = |
|
135 |
-INPUT_FILTER = |
|
136 |
-FILTER_PATTERNS = |
|
137 |
-FILTER_SOURCE_FILES = NO |
|
138 |
-#--------------------------------------------------------------------------- |
|
139 |
-# configuration options related to source browsing |
|
140 |
-#--------------------------------------------------------------------------- |
|
141 |
-SOURCE_BROWSER = YES |
|
142 |
-INLINE_SOURCES = NO |
|
143 |
-STRIP_CODE_COMMENTS = YES |
|
144 |
-REFERENCED_BY_RELATION = YES |
|
145 |
-REFERENCES_RELATION = YES |
|
146 |
-REFERENCES_LINK_SOURCE = YES |
|
147 |
-USE_HTAGS = NO |
|
148 |
-VERBATIM_HEADERS = YES |
|
149 |
-#--------------------------------------------------------------------------- |
|
150 |
-# configuration options related to the alphabetical class index |
|
151 |
-#--------------------------------------------------------------------------- |
|
152 |
-ALPHABETICAL_INDEX = NO |
|
153 |
-COLS_IN_ALPHA_INDEX = 5 |
|
154 |
-IGNORE_PREFIX = |
|
155 |
-#--------------------------------------------------------------------------- |
|
156 |
-# configuration options related to the HTML output |
|
157 |
-#--------------------------------------------------------------------------- |
|
158 |
-GENERATE_HTML = YES |
|
159 |
-HTML_OUTPUT = html |
|
160 |
-HTML_FILE_EXTENSION = .html |
|
161 |
-HTML_HEADER = |
|
162 |
-HTML_FOOTER = |
|
163 |
-HTML_STYLESHEET = |
|
164 |
-HTML_ALIGN_MEMBERS = YES |
|
165 |
-GENERATE_HTMLHELP = NO |
|
166 |
-GENERATE_DOCSET = NO |
|
167 |
-DOCSET_FEEDNAME = "Doxygen generated docs" |
|
168 |
-DOCSET_BUNDLE_ID = org.doxygen.Project |
|
169 |
-HTML_DYNAMIC_SECTIONS = NO |
|
170 |
-CHM_FILE = |
|
171 |
-HHC_LOCATION = |
|
172 |
-GENERATE_CHI = NO |
|
173 |
-BINARY_TOC = NO |
|
174 |
-TOC_EXPAND = NO |
|
175 |
-DISABLE_INDEX = NO |
|
176 |
-ENUM_VALUES_PER_LINE = 4 |
|
177 |
-GENERATE_TREEVIEW = NO |
|
178 |
-TREEVIEW_WIDTH = 250 |
|
179 |
-#--------------------------------------------------------------------------- |
|
180 |
-# configuration options related to the LaTeX output |
|
181 |
-#--------------------------------------------------------------------------- |
|
182 |
-GENERATE_LATEX = YES |
|
183 |
-LATEX_OUTPUT = latex |
|
184 |
-LATEX_CMD_NAME = latex |
|
185 |
-MAKEINDEX_CMD_NAME = makeindex |
|
186 |
-COMPACT_LATEX = YES # NO |
|
187 |
-PAPER_TYPE = a4wide |
|
188 |
-EXTRA_PACKAGES = |
|
189 |
-LATEX_HEADER = |
|
190 |
-PDF_HYPERLINKS = YES |
|
191 |
-USE_PDFLATEX = YES |
|
192 |
-LATEX_BATCHMODE = NO |
|
193 |
-LATEX_HIDE_INDICES = NO |
|
194 |
-#--------------------------------------------------------------------------- |
|
195 |
-# configuration options related to the RTF output |
|
196 |
-#--------------------------------------------------------------------------- |
|
197 |
-GENERATE_RTF = NO |
|
198 |
-RTF_OUTPUT = rtf |
|
199 |
-COMPACT_RTF = NO |
|
200 |
-RTF_HYPERLINKS = NO |
|
201 |
-RTF_STYLESHEET_FILE = |
|
202 |
-RTF_EXTENSIONS_FILE = |
|
203 |
-#--------------------------------------------------------------------------- |
|
204 |
-# configuration options related to the man page output |
|
205 |
-#--------------------------------------------------------------------------- |
|
206 |
-GENERATE_MAN = NO |
|
207 |
-MAN_OUTPUT = man |
|
208 |
-MAN_EXTENSION = .3 |
|
209 |
-MAN_LINKS = NO |
|
210 |
-#--------------------------------------------------------------------------- |
|
211 |
-# configuration options related to the XML output |
|
212 |
-#--------------------------------------------------------------------------- |
|
213 |
-GENERATE_XML = NO |
|
214 |
-XML_OUTPUT = xml |
|
215 |
-XML_SCHEMA = |
|
216 |
-XML_DTD = |
|
217 |
-XML_PROGRAMLISTING = YES |
|
218 |
-#--------------------------------------------------------------------------- |
|
219 |
-# configuration options for the AutoGen Definitions output |
|
220 |
-#--------------------------------------------------------------------------- |
|
221 |
-GENERATE_AUTOGEN_DEF = NO |
|
222 |
-#--------------------------------------------------------------------------- |
|
223 |
-# configuration options related to the Perl module output |
|
224 |
-#--------------------------------------------------------------------------- |
|
225 |
-GENERATE_PERLMOD = NO |
|
226 |
-PERLMOD_LATEX = NO |
|
227 |
-PERLMOD_PRETTY = YES |
|
228 |
-PERLMOD_MAKEVAR_PREFIX = |
|
229 |
-#--------------------------------------------------------------------------- |
|
230 |
-# Configuration options related to the preprocessor |
|
231 |
-#--------------------------------------------------------------------------- |
|
232 |
-ENABLE_PREPROCESSING = YES |
|
233 |
-MACRO_EXPANSION = NO |
|
234 |
-EXPAND_ONLY_PREDEF = NO |
|
235 |
-SEARCH_INCLUDES = YES |
|
236 |
-INCLUDE_PATH = |
|
237 |
-INCLUDE_FILE_PATTERNS = |
|
238 |
-PREDEFINED = _WIN32 NTLM USE_LZO ENABLE_FRAGMENT P2MP P2MP_SERVER ENABLE_CRYPTO ENABLE_CRYPTO_OPENSSL ENABLE_PLUGIN ENABLE_MANAGEMENT ENABLE_OCC HAVE_GETTIMEOFDAY |
|
239 |
-EXPAND_AS_DEFINED = |
|
240 |
-SKIP_FUNCTION_MACROS = YES |
|
241 |
-#--------------------------------------------------------------------------- |
|
242 |
-# Configuration::additions related to external references |
|
243 |
-#--------------------------------------------------------------------------- |
|
244 |
-TAGFILES = |
|
245 |
-GENERATE_TAGFILE = |
|
246 |
-ALLEXTERNALS = NO |
|
247 |
-EXTERNAL_GROUPS = YES |
|
248 |
-PERL_PATH = /usr/bin/perl |
|
249 |
-#--------------------------------------------------------------------------- |
|
250 |
-# Configuration options related to the dot tool |
|
251 |
-#--------------------------------------------------------------------------- |
|
252 |
-CLASS_DIAGRAMS = NO |
|
253 |
-MSCGEN_PATH = |
|
254 |
-HIDE_UNDOC_RELATIONS = YES |
|
255 |
-HAVE_DOT = YES |
|
256 |
-CLASS_GRAPH = YES |
|
257 |
-COLLABORATION_GRAPH = YES |
|
258 |
-GROUP_GRAPHS = YES |
|
259 |
-UML_LOOK = NO |
|
260 |
-TEMPLATE_RELATIONS = NO |
|
261 |
-INCLUDE_GRAPH = YES |
|
262 |
-INCLUDED_BY_GRAPH = YES |
|
263 |
-CALL_GRAPH = NO # YES |
|
264 |
-CALLER_GRAPH = NO # YES |
|
265 |
-GRAPHICAL_HIERARCHY = YES |
|
266 |
-DIRECTORY_GRAPH = YES |
|
267 |
-DOT_IMAGE_FORMAT = png |
|
268 |
-DOT_PATH = "/usr/bin/dot" |
|
269 |
-DOTFILE_DIRS = |
|
270 |
-DOT_GRAPH_MAX_NODES = 50 |
|
271 |
-MAX_DOT_GRAPH_DEPTH = 1000 |
|
272 |
-DOT_TRANSPARENT = YES |
|
273 |
-DOT_MULTI_TARGETS = NO |
|
274 |
-GENERATE_LEGEND = YES |
|
275 |
-DOT_CLEANUP = YES |
|
276 |
-#--------------------------------------------------------------------------- |
|
277 |
-# Configuration::additions related to the search engine |
|
278 |
-#--------------------------------------------------------------------------- |
|
279 |
-SEARCHENGINE = NO |
280 | 1 |
new file mode 100644 |
... | ... |
@@ -0,0 +1,279 @@ |
0 |
+# Doxyfile 1.5.5 |
|
1 |
+ |
|
2 |
+#--------------------------------------------------------------------------- |
|
3 |
+# Project related configuration options |
|
4 |
+#--------------------------------------------------------------------------- |
|
5 |
+DOXYFILE_ENCODING = UTF-8 |
|
6 |
+PROJECT_NAME = "OpenVPN" |
|
7 |
+PROJECT_NUMBER = |
|
8 |
+OUTPUT_DIRECTORY = "@abs_top_builddir@/doc/doxygen" |
|
9 |
+CREATE_SUBDIRS = NO |
|
10 |
+OUTPUT_LANGUAGE = English |
|
11 |
+BRIEF_MEMBER_DESC = YES |
|
12 |
+REPEAT_BRIEF = YES |
|
13 |
+ABBREVIATE_BRIEF = "The $name class" \ |
|
14 |
+ "The $name widget" \ |
|
15 |
+ "The $name file" \ |
|
16 |
+ is \ |
|
17 |
+ provides \ |
|
18 |
+ specifies \ |
|
19 |
+ contains \ |
|
20 |
+ represents \ |
|
21 |
+ a \ |
|
22 |
+ an \ |
|
23 |
+ the |
|
24 |
+ALWAYS_DETAILED_SEC = NO |
|
25 |
+INLINE_INHERITED_MEMB = NO |
|
26 |
+FULL_PATH_NAMES = YES |
|
27 |
+STRIP_FROM_PATH = "@abs_top_srcdir@" |
|
28 |
+STRIP_FROM_INC_PATH = |
|
29 |
+SHORT_NAMES = NO |
|
30 |
+JAVADOC_AUTOBRIEF = YES # NO |
|
31 |
+QT_AUTOBRIEF = NO |
|
32 |
+MULTILINE_CPP_IS_BRIEF = NO |
|
33 |
+DETAILS_AT_TOP = NO |
|
34 |
+INHERIT_DOCS = YES |
|
35 |
+SEPARATE_MEMBER_PAGES = NO |
|
36 |
+TAB_SIZE = 8 |
|
37 |
+ALIASES = |
|
38 |
+OPTIMIZE_OUTPUT_FOR_C = YES |
|
39 |
+OPTIMIZE_OUTPUT_JAVA = NO |
|
40 |
+OPTIMIZE_FOR_FORTRAN = NO |
|
41 |
+OPTIMIZE_OUTPUT_VHDL = NO |
|
42 |
+BUILTIN_STL_SUPPORT = NO |
|
43 |
+CPP_CLI_SUPPORT = NO |
|
44 |
+SIP_SUPPORT = NO |
|
45 |
+DISTRIBUTE_GROUP_DOC = NO |
|
46 |
+SUBGROUPING = YES |
|
47 |
+TYPEDEF_HIDES_STRUCT = NO |
|
48 |
+#--------------------------------------------------------------------------- |
|
49 |
+# Build related configuration options |
|
50 |
+#--------------------------------------------------------------------------- |
|
51 |
+EXTRACT_ALL = YES |
|
52 |
+EXTRACT_PRIVATE = YES |
|
53 |
+EXTRACT_STATIC = YES |
|
54 |
+EXTRACT_LOCAL_CLASSES = YES |
|
55 |
+EXTRACT_LOCAL_METHODS = YES |
|
56 |
+EXTRACT_ANON_NSPACES = YES |
|
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 |
+SHOW_INCLUDE_FILES = YES |
|
65 |
+INLINE_INFO = YES |
|
66 |
+SORT_MEMBER_DOCS = YES |
|
67 |
+SORT_BRIEF_DOCS = NO |
|
68 |
+SORT_GROUP_NAMES = NO |
|
69 |
+SORT_BY_SCOPE_NAME = NO |
|
70 |
+GENERATE_TODOLIST = YES |
|
71 |
+GENERATE_TESTLIST = YES |
|
72 |
+GENERATE_BUGLIST = YES |
|
73 |
+GENERATE_DEPRECATEDLIST= YES |
|
74 |
+ENABLED_SECTIONS = |
|
75 |
+MAX_INITIALIZER_LINES = 30 |
|
76 |
+SHOW_USED_FILES = YES |
|
77 |
+SHOW_DIRECTORIES = NO |
|
78 |
+FILE_VERSION_FILTER = |
|
79 |
+#--------------------------------------------------------------------------- |
|
80 |
+# configuration options related to warning and progress messages |
|
81 |
+#--------------------------------------------------------------------------- |
|
82 |
+QUIET = NO |
|
83 |
+WARNINGS = YES |
|
84 |
+WARN_IF_UNDOCUMENTED = YES |
|
85 |
+WARN_IF_DOC_ERROR = YES |
|
86 |
+WARN_NO_PARAMDOC = NO |
|
87 |
+WARN_FORMAT = "$file:$line: $text" |
|
88 |
+WARN_LOGFILE = |
|
89 |
+#--------------------------------------------------------------------------- |
|
90 |
+# configuration options related to the input files |
|
91 |
+#--------------------------------------------------------------------------- |
|
92 |
+INPUT = "@abs_top_srcdir@" |
|
93 |
+INPUT_ENCODING = UTF-8 |
|
94 |
+FILE_PATTERNS = *.c \ |
|
95 |
+ *.cc \ |
|
96 |
+ *.cxx \ |
|
97 |
+ *.cpp \ |
|
98 |
+ *.c++ \ |
|
99 |
+ *.d \ |
|
100 |
+ *.java \ |
|
101 |
+ *.ii \ |
|
102 |
+ *.ixx \ |
|
103 |
+ *.ipp \ |
|
104 |
+ *.i++ \ |
|
105 |
+ *.inl \ |
|
106 |
+ *.h \ |
|
107 |
+ *.hh \ |
|
108 |
+ *.hxx \ |
|
109 |
+ *.hpp \ |
|
110 |
+ *.h++ \ |
|
111 |
+ *.idl \ |
|
112 |
+ *.odl \ |
|
113 |
+ *.cs \ |
|
114 |
+ *.php \ |
|
115 |
+ *.php3 \ |
|
116 |
+ *.inc \ |
|
117 |
+ *.m \ |
|
118 |
+ *.mm \ |
|
119 |
+ *.dox \ |
|
120 |
+ *.py \ |
|
121 |
+ *.f90 \ |
|
122 |
+ *.f \ |
|
123 |
+ *.vhd \ |
|
124 |
+ *.vhdl |
|
125 |
+RECURSIVE = YES |
|
126 |
+EXCLUDE = |
|
127 |
+EXCLUDE_SYMLINKS = NO |
|
128 |
+EXCLUDE_PATTERNS = |
|
129 |
+EXCLUDE_SYMBOLS = |
|
130 |
+EXAMPLE_PATH = |
|
131 |
+EXAMPLE_PATTERNS = * |
|
132 |
+EXAMPLE_RECURSIVE = NO |
|
133 |
+IMAGE_PATH = |
|
134 |
+INPUT_FILTER = |
|
135 |
+FILTER_PATTERNS = |
|
136 |
+FILTER_SOURCE_FILES = NO |
|
137 |
+#--------------------------------------------------------------------------- |
|
138 |
+# configuration options related to source browsing |
|
139 |
+#--------------------------------------------------------------------------- |
|
140 |
+SOURCE_BROWSER = YES |
|
141 |
+INLINE_SOURCES = NO |
|
142 |
+STRIP_CODE_COMMENTS = YES |
|
143 |
+REFERENCED_BY_RELATION = YES |
|
144 |
+REFERENCES_RELATION = YES |
|
145 |
+REFERENCES_LINK_SOURCE = YES |
|
146 |
+USE_HTAGS = NO |
|
147 |
+VERBATIM_HEADERS = YES |
|
148 |
+#--------------------------------------------------------------------------- |
|
149 |
+# configuration options related to the alphabetical class index |
|
150 |
+#--------------------------------------------------------------------------- |
|
151 |
+ALPHABETICAL_INDEX = NO |
|
152 |
+COLS_IN_ALPHA_INDEX = 5 |
|
153 |
+IGNORE_PREFIX = |
|
154 |
+#--------------------------------------------------------------------------- |
|
155 |
+# configuration options related to the HTML output |
|
156 |
+#--------------------------------------------------------------------------- |
|
157 |
+GENERATE_HTML = YES |
|
158 |
+HTML_OUTPUT = html |
|
159 |
+HTML_FILE_EXTENSION = .html |
|
160 |
+HTML_HEADER = |
|
161 |
+HTML_FOOTER = |
|
162 |
+HTML_STYLESHEET = |
|
163 |
+HTML_ALIGN_MEMBERS = YES |
|
164 |
+GENERATE_HTMLHELP = NO |
|
165 |
+GENERATE_DOCSET = NO |
|
166 |
+DOCSET_FEEDNAME = "Doxygen generated docs" |
|
167 |
+DOCSET_BUNDLE_ID = org.doxygen.Project |
|
168 |
+HTML_DYNAMIC_SECTIONS = NO |
|
169 |
+CHM_FILE = |
|
170 |
+HHC_LOCATION = |
|
171 |
+GENERATE_CHI = NO |
|
172 |
+BINARY_TOC = NO |
|
173 |
+TOC_EXPAND = NO |
|
174 |
+DISABLE_INDEX = NO |
|
175 |
+ENUM_VALUES_PER_LINE = 4 |
|
176 |
+GENERATE_TREEVIEW = NO |
|
177 |
+TREEVIEW_WIDTH = 250 |
|
178 |
+#--------------------------------------------------------------------------- |
|
179 |
+# configuration options related to the LaTeX output |
|
180 |
+#--------------------------------------------------------------------------- |
|
181 |
+GENERATE_LATEX = YES |
|
182 |
+LATEX_OUTPUT = latex |
|
183 |
+LATEX_CMD_NAME = latex |
|
184 |
+MAKEINDEX_CMD_NAME = makeindex |
|
185 |
+COMPACT_LATEX = YES # NO |
|
186 |
+PAPER_TYPE = a4wide |
|
187 |
+EXTRA_PACKAGES = |
|
188 |
+LATEX_HEADER = |
|
189 |
+PDF_HYPERLINKS = YES |
|
190 |
+USE_PDFLATEX = YES |
|
191 |
+LATEX_BATCHMODE = NO |
|
192 |
+LATEX_HIDE_INDICES = NO |
|
193 |
+#--------------------------------------------------------------------------- |
|
194 |
+# configuration options related to the RTF output |
|
195 |
+#--------------------------------------------------------------------------- |
|
196 |
+GENERATE_RTF = NO |
|
197 |
+RTF_OUTPUT = rtf |
|
198 |
+COMPACT_RTF = NO |
|
199 |
+RTF_HYPERLINKS = NO |
|
200 |
+RTF_STYLESHEET_FILE = |
|
201 |
+RTF_EXTENSIONS_FILE = |
|
202 |
+#--------------------------------------------------------------------------- |
|
203 |
+# configuration options related to the man page output |
|
204 |
+#--------------------------------------------------------------------------- |
|
205 |
+GENERATE_MAN = NO |
|
206 |
+MAN_OUTPUT = man |
|
207 |
+MAN_EXTENSION = .3 |
|
208 |
+MAN_LINKS = NO |
|
209 |
+#--------------------------------------------------------------------------- |
|
210 |
+# configuration options related to the XML output |
|
211 |
+#--------------------------------------------------------------------------- |
|
212 |
+GENERATE_XML = NO |
|
213 |
+XML_OUTPUT = xml |
|
214 |
+XML_SCHEMA = |
|
215 |
+XML_DTD = |
|
216 |
+XML_PROGRAMLISTING = YES |
|
217 |
+#--------------------------------------------------------------------------- |
|
218 |
+# configuration options for the AutoGen Definitions output |
|
219 |
+#--------------------------------------------------------------------------- |
|
220 |
+GENERATE_AUTOGEN_DEF = NO |
|
221 |
+#--------------------------------------------------------------------------- |
|
222 |
+# configuration options related to the Perl module output |
|
223 |
+#--------------------------------------------------------------------------- |
|
224 |
+GENERATE_PERLMOD = NO |
|
225 |
+PERLMOD_LATEX = NO |
|
226 |
+PERLMOD_PRETTY = YES |
|
227 |
+PERLMOD_MAKEVAR_PREFIX = |
|
228 |
+#--------------------------------------------------------------------------- |
|
229 |
+# Configuration options related to the preprocessor |
|
230 |
+#--------------------------------------------------------------------------- |
|
231 |
+ENABLE_PREPROCESSING = YES |
|
232 |
+MACRO_EXPANSION = NO |
|
233 |
+EXPAND_ONLY_PREDEF = NO |
|
234 |
+SEARCH_INCLUDES = YES |
|
235 |
+INCLUDE_PATH = |
|
236 |
+INCLUDE_FILE_PATTERNS = |
|
237 |
+PREDEFINED = _WIN32 NTLM USE_LZO ENABLE_FRAGMENT P2MP P2MP_SERVER ENABLE_CRYPTO ENABLE_CRYPTO_OPENSSL ENABLE_PLUGIN ENABLE_MANAGEMENT ENABLE_OCC HAVE_GETTIMEOFDAY |
|
238 |
+EXPAND_AS_DEFINED = |
|
239 |
+SKIP_FUNCTION_MACROS = YES |
|
240 |
+#--------------------------------------------------------------------------- |
|
241 |
+# Configuration::additions related to external references |
|
242 |
+#--------------------------------------------------------------------------- |
|
243 |
+TAGFILES = |
|
244 |
+GENERATE_TAGFILE = |
|
245 |
+ALLEXTERNALS = NO |
|
246 |
+EXTERNAL_GROUPS = YES |
|
247 |
+PERL_PATH = /usr/bin/perl |
|
248 |
+#--------------------------------------------------------------------------- |
|
249 |
+# Configuration options related to the dot tool |
|
250 |
+#--------------------------------------------------------------------------- |
|
251 |
+CLASS_DIAGRAMS = NO |
|
252 |
+MSCGEN_PATH = |
|
253 |
+HIDE_UNDOC_RELATIONS = YES |
|
254 |
+HAVE_DOT = YES |
|
255 |
+CLASS_GRAPH = YES |
|
256 |
+COLLABORATION_GRAPH = YES |
|
257 |
+GROUP_GRAPHS = YES |
|
258 |
+UML_LOOK = NO |
|
259 |
+TEMPLATE_RELATIONS = NO |
|
260 |
+INCLUDE_GRAPH = YES |
|
261 |
+INCLUDED_BY_GRAPH = YES |
|
262 |
+CALL_GRAPH = NO # YES |
|
263 |
+CALLER_GRAPH = NO # YES |
|
264 |
+GRAPHICAL_HIERARCHY = YES |
|
265 |
+DIRECTORY_GRAPH = YES |
|
266 |
+DOT_IMAGE_FORMAT = png |
|
267 |
+DOT_PATH = "/usr/bin/dot" |
|
268 |
+DOTFILE_DIRS = |
|
269 |
+DOT_GRAPH_MAX_NODES = 50 |
|
270 |
+MAX_DOT_GRAPH_DEPTH = 1000 |
|
271 |
+DOT_TRANSPARENT = YES |
|
272 |
+DOT_MULTI_TARGETS = NO |
|
273 |
+GENERATE_LEGEND = YES |
|
274 |
+DOT_CLEANUP = YES |
|
275 |
+#--------------------------------------------------------------------------- |
|
276 |
+# Configuration::additions related to the search engine |
|
277 |
+#--------------------------------------------------------------------------- |
|
278 |
+SEARCHENGINE = NO |