Merge lp:~michihenning/unity/doxygen into lp:unity/phablet
- doxygen
- Merge into phablet
Status: | Merged |
---|---|
Approved by: | Michał Sawicz |
Approved revision: | no longer in the source branch. |
Merged at revision: | 617 |
Proposed branch: | lp:~michihenning/unity/doxygen |
Merge into: | lp:unity/phablet |
Diff against target: |
1986 lines (+1874/-3) 11 files modified
CMakeLists.txt (+20/-0) debian/control (+10/-2) debian/libunity-api-doc.install (+1/-0) doc/Doxyfile.in (+1826/-0) include/CMakeLists.txt (+2/-0) include/unity/CMakeLists.txt (+3/-0) include/unity/api/CMakeLists.txt (+3/-0) include/unity/scopes/CMakeLists.txt (+3/-0) include/unity/util/CMakeLists.txt (+3/-0) src/CMakeLists.txt (+2/-0) src/unity/api/scopes/internal/CMakeLists.txt (+1/-1) |
To merge this branch: | bzr merge lp:~michihenning/unity/doxygen |
Related bugs: |
Reviewer | Review Type | Date Requested | Status |
---|---|---|---|
Jussi Pakkanen (community) | Approve | ||
PS Jenkins bot (community) | continuous-integration | Approve | |
Michał Sawicz | Needs Information | ||
Review via email:
|
Commit message
generate API docs with doxygen
This change adds support for generating API docs with doxygen. "make doc" generates the documentation. The HTML output is placed into buiilddir/
Description of the change
This change adds support for generating API docs with doxygen. "make doc" generates the documentation. The HTML output is placed into buiilddir/
![](/+icing/build/overlay/assets/skins/sam/images/close.gif)
PS Jenkins bot (ps-jenkins) wrote : | # |
![](/+icing/build/overlay/assets/skins/sam/images/close.gif)
PS Jenkins bot (ps-jenkins) wrote : | # |
FAILED: Continuous integration, rev:604
http://
Executed test runs:
FAILURE: http://
SUCCESS: http://
deb: http://
SUCCESS: http://
SUCCESS: http://
deb: http://
SUCCESS: http://
SUCCESS: http://
Click here to trigger a rebuild:
http://
![](/+icing/build/overlay/assets/skins/sam/images/close.gif)
PS Jenkins bot (ps-jenkins) wrote : | # |
FAILED: Continuous integration, rev:604
http://
Executed test runs:
FAILURE: http://
SUCCESS: http://
deb: http://
SUCCESS: http://
SUCCESS: http://
deb: http://
SUCCESS: http://
SUCCESS: http://
Click here to trigger a rebuild:
http://
![](/+icing/build/overlay/assets/skins/sam/images/close.gif)
PS Jenkins bot (ps-jenkins) wrote : | # |
PASSED: Continuous integration, rev:604
http://
Executed test runs:
SUCCESS: http://
SUCCESS: http://
deb: http://
SUCCESS: http://
SUCCESS: http://
deb: http://
SUCCESS: http://
SUCCESS: http://
Click here to trigger a rebuild:
http://
![](/+icing/build/overlay/assets/skins/sam/images/close.gif)
Michał Sawicz (saviq) wrote : | # |
graphviz is also needed in the deps and the CMake check
![](/+icing/build/overlay/assets/skins/sam/images/close.gif)
Michi Henning (michihenning) wrote : | # |
> graphviz is also needed in the deps and the CMake check
Should be fixed now, thanks!
![](/+icing/build/overlay/assets/skins/sam/images/close.gif)
PS Jenkins bot (ps-jenkins) wrote : | # |
PASSED: Continuous integration, rev:605
http://
Executed test runs:
SUCCESS: http://
SUCCESS: http://
deb: http://
SUCCESS: http://
SUCCESS: http://
deb: http://
SUCCESS: http://
SUCCESS: http://
Click here to trigger a rebuild:
http://
![](/+icing/build/overlay/assets/skins/sam/images/close.gif)
Michał Sawicz (saviq) wrote : | # |
Do we want to install that documentation with libunity-api-doc?
![](/+icing/build/overlay/assets/skins/sam/images/close.gif)
Michi Henning (michihenning) wrote : | # |
> Do we want to install that documentation with libunity-api-doc?
Hmmm... Should that be a separate package or would it make better sense to just throw it in with the dev package? It seems sort of pointless to install the headers, but not the doc?
![](/+icing/build/overlay/assets/skins/sam/images/close.gif)
Michi Henning (michihenning) wrote : | # |
> Hmmm... Should that be a separate package or would it make better sense to
> just throw it in with the dev package? It seems sort of pointless to install
> the headers, but not the doc?
Looks like most libraries permit the doc to be installed separately, without a dependency on the dev package, so I'll do that.
![](/+icing/build/overlay/assets/skins/sam/images/close.gif)
PS Jenkins bot (ps-jenkins) wrote : | # |
FAILED: Continuous integration, rev:607
http://
Executed test runs:
FAILURE: http://
FAILURE: http://
FAILURE: http://
FAILURE: http://
FAILURE: http://
Click here to trigger a rebuild:
http://
![](/+icing/build/overlay/assets/skins/sam/images/close.gif)
PS Jenkins bot (ps-jenkins) wrote : | # |
FAILED: Continuous integration, rev:608
http://
Executed test runs:
FAILURE: http://
FAILURE: http://
FAILURE: http://
FAILURE: http://
FAILURE: http://
Click here to trigger a rebuild:
http://
![](/+icing/build/overlay/assets/skins/sam/images/close.gif)
PS Jenkins bot (ps-jenkins) wrote : | # |
FAILED: Continuous integration, rev:609
http://
Executed test runs:
UNSTABLE: http://
SUCCESS: http://
deb: http://
SUCCESS: http://
SUCCESS: http://
deb: http://
SUCCESS: http://
SUCCESS: http://
Click here to trigger a rebuild:
http://
![](/+icing/build/overlay/assets/skins/sam/images/close.gif)
PS Jenkins bot (ps-jenkins) wrote : | # |
FAILED: Continuous integration, rev:609
http://
Executed test runs:
FAILURE: http://
SUCCESS: http://
deb: http://
SUCCESS: http://
SUCCESS: http://
deb: http://
SUCCESS: http://
SUCCESS: http://
Click here to trigger a rebuild:
http://
![](/+icing/build/overlay/assets/skins/sam/images/close.gif)
PS Jenkins bot (ps-jenkins) wrote : | # |
PASSED: Continuous integration, rev:609
http://
Executed test runs:
SUCCESS: http://
SUCCESS: http://
deb: http://
SUCCESS: http://
SUCCESS: http://
deb: http://
SUCCESS: http://
SUCCESS: http://
Click here to trigger a rebuild:
http://
![](/+icing/build/overlay/assets/skins/sam/images/close.gif)
Jussi Pakkanen (jpakkane) wrote : | # |
In CMake any variable that has the form "XXX-NOTFOUND" has the truth value of false.
Thus this declaration:
if (NOT DOXYGEN_FOUND OR ${DOT_EXECUTABLE} STREQUAL "DOT_EXECUTABLE
can be simplified to this:
if (NOT DOXYGEN_FOUND OR NOT DOT_EXECUTABLE)
![](/+icing/build/overlay/assets/skins/sam/images/close.gif)
Michi Henning (michihenning) wrote : | # |
> can be simplified to this:
>
> if (NOT DOXYGEN_FOUND OR NOT DOT_EXECUTABLE)
Thanks for that!
![](/+icing/build/overlay/assets/skins/sam/images/close.gif)
PS Jenkins bot (ps-jenkins) wrote : | # |
PASSED: Continuous integration, rev:610
http://
Executed test runs:
SUCCESS: http://
SUCCESS: http://
deb: http://
SUCCESS: http://
SUCCESS: http://
deb: http://
SUCCESS: http://
SUCCESS: http://
Click here to trigger a rebuild:
http://
Preview Diff
1 | === modified file 'CMakeLists.txt' |
2 | --- CMakeLists.txt 2013-04-18 18:21:23 +0000 |
3 | +++ CMakeLists.txt 2013-04-22 12:13:31 +0000 |
4 | @@ -175,3 +175,23 @@ |
5 | DESTINATION ${CMAKE_INSTALL_DATADIR}/applications |
6 | ) |
7 | |
8 | +# |
9 | +# Documentation |
10 | +# |
11 | + |
12 | +find_package(Doxygen) |
13 | +find_program(DOT_EXECUTABLE dot /usr/bin) |
14 | +if (NOT DOXYGEN_FOUND OR NOT DOT_EXECUTABLE) |
15 | + message(WARNING "Cannot generate documentation: doxygen and/or graphviz not found") |
16 | +else() |
17 | + configure_file(${PROJECT_SOURCE_DIR}/doc/Doxyfile.in ${PROJECT_BINARY_DIR}/doc/Doxyfile @ONLY IMMEDIATE) |
18 | + add_custom_command(OUTPUT ${PROJECT_BINARY_DIR}/doc/lib${UNITY_API_LIB}/index.html |
19 | + COMMAND ${DOXYGEN_EXECUTABLE} ${PROJECT_BINARY_DIR}/doc/Doxyfile |
20 | + DEPENDS ${PROJECT_BINARY_DIR}/doc/Doxyfile |
21 | + ${UNITY_API_LIB_SRC} |
22 | + ${UNITY_API_LIB_HDRS}) |
23 | + add_custom_target(doc ALL |
24 | + DEPENDS ${PROJECT_BINARY_DIR}/doc/lib${UNITY_API_LIB}/index.html) |
25 | + install(DIRECTORY ${PROJECT_BINARY_DIR}/doc/lib${UNITY_API_LIB} |
26 | + DESTINATION ${CMAKE_INSTALL_PREFIX}/share/doc) |
27 | +endif() |
28 | |
29 | === modified file 'debian/control' |
30 | --- debian/control 2013-04-18 18:21:23 +0000 |
31 | +++ debian/control 2013-04-22 12:13:31 +0000 |
32 | @@ -27,6 +27,8 @@ |
33 | libgtest-dev, |
34 | libc6-dev, |
35 | python3, |
36 | + doxygen, |
37 | + graphviz, |
38 | Standards-Version: 3.9.3 |
39 | Vcs-Bzr: lp:unity/phablet |
40 | |
41 | @@ -74,7 +76,7 @@ |
42 | Depends: ${shlibs:Depends}, |
43 | ${misc:Depends}, |
44 | Description: API for shell integration |
45 | - The Unity API permits integration with the shell, for example, to add indicators or notifications. |
46 | + Library to integrate with the Unity shell |
47 | |
48 | Package: libunity-api-dev |
49 | Architecture: all |
50 | @@ -82,4 +84,10 @@ |
51 | libunity-api (= ${binary:Version}), |
52 | libboost1.49-dev (>= 1.49), |
53 | Description: Header files for Unity API |
54 | - The Unity API permits integration with the shell, for example, to add indicators or notifications. |
55 | + Library to integrate with the Unity shell (dev files) |
56 | + |
57 | +Package: libunity-api-doc |
58 | +Architecture: all |
59 | +Depends: ${misc:Depends}, |
60 | +Description: Documentation for Unity API |
61 | + Library to integrate with the Unity shell (documentation) |
62 | |
63 | === added file 'debian/libunity-api-doc.install' |
64 | --- debian/libunity-api-doc.install 1970-01-01 00:00:00 +0000 |
65 | +++ debian/libunity-api-doc.install 2013-04-22 12:13:31 +0000 |
66 | @@ -0,0 +1,1 @@ |
67 | +usr/share/doc/libunity-api/* |
68 | |
69 | === added directory 'doc' |
70 | === added file 'doc/Doxyfile.in' |
71 | --- doc/Doxyfile.in 1970-01-01 00:00:00 +0000 |
72 | +++ doc/Doxyfile.in 2013-04-22 12:13:31 +0000 |
73 | @@ -0,0 +1,1826 @@ |
74 | +# Doxyfile 1.8.1.2 |
75 | + |
76 | +# This file describes the settings to be used by the documentation system |
77 | +# doxygen (www.doxygen.org) for a project |
78 | +# |
79 | +# All text after a hash (#) is considered a comment and will be ignored |
80 | +# The format is: |
81 | +# TAG = value [value, ...] |
82 | +# For lists items can also be appended using: |
83 | +# TAG += value [value, ...] |
84 | +# Values that contain spaces should be placed between quotes (" ") |
85 | + |
86 | +#--------------------------------------------------------------------------- |
87 | +# Project related configuration options |
88 | +#--------------------------------------------------------------------------- |
89 | + |
90 | +# This tag specifies the encoding used for all characters in the config file |
91 | +# that follow. The default is UTF-8 which is also the encoding used for all |
92 | +# text before the first occurrence of this tag. Doxygen uses libiconv (or the |
93 | +# iconv built into libc) for the transcoding. See |
94 | +# http://www.gnu.org/software/libiconv for the list of possible encodings. |
95 | + |
96 | +DOXYFILE_ENCODING = UTF-8 |
97 | + |
98 | +# The PROJECT_NAME tag is a single word (or sequence of words) that should |
99 | +# identify the project. Note that if you do not use Doxywizard you need |
100 | +# to put quotes around the project name if it contains spaces. |
101 | + |
102 | +PROJECT_NAME = "My Project" |
103 | + |
104 | +# The PROJECT_NUMBER tag can be used to enter a project or revision number. |
105 | +# This could be handy for archiving the generated documentation or |
106 | +# if some version control system is used. |
107 | + |
108 | +PROJECT_NUMBER = |
109 | + |
110 | +# Using the PROJECT_BRIEF tag one can provide an optional one line description |
111 | +# for a project that appears at the top of each page and should give viewer |
112 | +# a quick idea about the purpose of the project. Keep the description short. |
113 | + |
114 | +PROJECT_BRIEF = |
115 | + |
116 | +# With the PROJECT_LOGO tag one can specify an logo or icon that is |
117 | +# included in the documentation. The maximum height of the logo should not |
118 | +# exceed 55 pixels and the maximum width should not exceed 200 pixels. |
119 | +# Doxygen will copy the logo to the output directory. |
120 | + |
121 | +PROJECT_LOGO = |
122 | + |
123 | +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) |
124 | +# base path where the generated documentation will be put. |
125 | +# If a relative path is entered, it will be relative to the location |
126 | +# where doxygen was started. If left blank the current directory will be used. |
127 | + |
128 | +OUTPUT_DIRECTORY = @PROJECT_BINARY_DIR@/doc |
129 | + |
130 | +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create |
131 | +# 4096 sub-directories (in 2 levels) under the output directory of each output |
132 | +# format and will distribute the generated files over these directories. |
133 | +# Enabling this option can be useful when feeding doxygen a huge amount of |
134 | +# source files, where putting all generated files in the same directory would |
135 | +# otherwise cause performance problems for the file system. |
136 | + |
137 | +CREATE_SUBDIRS = NO |
138 | + |
139 | +# The OUTPUT_LANGUAGE tag is used to specify the language in which all |
140 | +# documentation generated by doxygen is written. Doxygen will use this |
141 | +# information to generate all constant output in the proper language. |
142 | +# The default language is English, other supported languages are: |
143 | +# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, |
144 | +# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, |
145 | +# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English |
146 | +# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, |
147 | +# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, |
148 | +# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. |
149 | + |
150 | +OUTPUT_LANGUAGE = English |
151 | + |
152 | +# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will |
153 | +# include brief member descriptions after the members that are listed in |
154 | +# the file and class documentation (similar to JavaDoc). |
155 | +# Set to NO to disable this. |
156 | + |
157 | +BRIEF_MEMBER_DESC = YES |
158 | + |
159 | +# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend |
160 | +# the brief description of a member or function before the detailed description. |
161 | +# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the |
162 | +# brief descriptions will be completely suppressed. |
163 | + |
164 | +REPEAT_BRIEF = YES |
165 | + |
166 | +# This tag implements a quasi-intelligent brief description abbreviator |
167 | +# that is used to form the text in various listings. Each string |
168 | +# in this list, if found as the leading text of the brief description, will be |
169 | +# stripped from the text and the result after processing the whole list, is |
170 | +# used as the annotated text. Otherwise, the brief description is used as-is. |
171 | +# If left blank, the following values are used ("$name" is automatically |
172 | +# replaced with the name of the entity): "The $name class" "The $name widget" |
173 | +# "The $name file" "is" "provides" "specifies" "contains" |
174 | +# "represents" "a" "an" "the" |
175 | + |
176 | +ABBREVIATE_BRIEF = "The $name class" \ |
177 | + "The $name widget" \ |
178 | + "The $name file" \ |
179 | + is \ |
180 | + provides \ |
181 | + specifies \ |
182 | + contains \ |
183 | + represents \ |
184 | + a \ |
185 | + an \ |
186 | + the |
187 | + |
188 | +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then |
189 | +# Doxygen will generate a detailed section even if there is only a brief |
190 | +# description. |
191 | + |
192 | +ALWAYS_DETAILED_SEC = NO |
193 | + |
194 | +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all |
195 | +# inherited members of a class in the documentation of that class as if those |
196 | +# members were ordinary class members. Constructors, destructors and assignment |
197 | +# operators of the base classes will not be shown. |
198 | + |
199 | +INLINE_INHERITED_MEMB = NO |
200 | + |
201 | +# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full |
202 | +# path before files name in the file list and in the header files. If set |
203 | +# to NO the shortest path that makes the file name unique will be used. |
204 | + |
205 | +FULL_PATH_NAMES = YES |
206 | + |
207 | +# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag |
208 | +# can be used to strip a user-defined part of the path. Stripping is |
209 | +# only done if one of the specified strings matches the left-hand part of |
210 | +# the path. The tag can be used to show relative paths in the file list. |
211 | +# If left blank the directory from which doxygen is run is used as the |
212 | +# path to strip. |
213 | + |
214 | +STRIP_FROM_PATH = @PROJECT_SOURCE_DIR@ @PROJECT_BINARY_DIR@ |
215 | + |
216 | +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of |
217 | +# the path mentioned in the documentation of a class, which tells |
218 | +# the reader which header file to include in order to use a class. |
219 | +# If left blank only the name of the header file containing the class |
220 | +# definition is used. Otherwise one should specify the include paths that |
221 | +# are normally passed to the compiler using the -I flag. |
222 | + |
223 | +STRIP_FROM_INC_PATH = @PROJECT_SOURCE_DIR@/include @PROJECT_BINARY_DIR@/include |
224 | + |
225 | +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter |
226 | +# (but less readable) file names. This can be useful if your file system |
227 | +# doesn't support long names like on DOS, Mac, or CD-ROM. |
228 | + |
229 | +SHORT_NAMES = NO |
230 | + |
231 | +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen |
232 | +# will interpret the first line (until the first dot) of a JavaDoc-style |
233 | +# comment as the brief description. If set to NO, the JavaDoc |
234 | +# comments will behave just like regular Qt-style comments |
235 | +# (thus requiring an explicit @brief command for a brief description.) |
236 | + |
237 | +JAVADOC_AUTOBRIEF = NO |
238 | + |
239 | +# If the QT_AUTOBRIEF tag is set to YES then Doxygen will |
240 | +# interpret the first line (until the first dot) of a Qt-style |
241 | +# comment as the brief description. If set to NO, the comments |
242 | +# will behave just like regular Qt-style comments (thus requiring |
243 | +# an explicit \brief command for a brief description.) |
244 | + |
245 | +QT_AUTOBRIEF = NO |
246 | + |
247 | +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen |
248 | +# treat a multi-line C++ special comment block (i.e. a block of //! or /// |
249 | +# comments) as a brief description. This used to be the default behaviour. |
250 | +# The new default is to treat a multi-line C++ comment block as a detailed |
251 | +# description. Set this tag to YES if you prefer the old behaviour instead. |
252 | + |
253 | +MULTILINE_CPP_IS_BRIEF = NO |
254 | + |
255 | +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented |
256 | +# member inherits the documentation from any documented member that it |
257 | +# re-implements. |
258 | + |
259 | +INHERIT_DOCS = YES |
260 | + |
261 | +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce |
262 | +# a new page for each member. If set to NO, the documentation of a member will |
263 | +# be part of the file/class/namespace that contains it. |
264 | + |
265 | +SEPARATE_MEMBER_PAGES = NO |
266 | + |
267 | +# The TAB_SIZE tag can be used to set the number of spaces in a tab. |
268 | +# Doxygen uses this value to replace tabs by spaces in code fragments. |
269 | + |
270 | +TAB_SIZE = 8 |
271 | + |
272 | +# This tag can be used to specify a number of aliases that acts |
273 | +# as commands in the documentation. An alias has the form "name=value". |
274 | +# For example adding "sideeffect=\par Side Effects:\n" will allow you to |
275 | +# put the command \sideeffect (or @sideeffect) in the documentation, which |
276 | +# will result in a user-defined paragraph with heading "Side Effects:". |
277 | +# You can put \n's in the value part of an alias to insert newlines. |
278 | + |
279 | +ALIASES = |
280 | + |
281 | +# This tag can be used to specify a number of word-keyword mappings (TCL only). |
282 | +# A mapping has the form "name=value". For example adding |
283 | +# "class=itcl::class" will allow you to use the command class in the |
284 | +# itcl::class meaning. |
285 | + |
286 | +TCL_SUBST = |
287 | + |
288 | +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C |
289 | +# sources only. Doxygen will then generate output that is more tailored for C. |
290 | +# For instance, some of the names that are used will be different. The list |
291 | +# of all members will be omitted, etc. |
292 | + |
293 | +OPTIMIZE_OUTPUT_FOR_C = NO |
294 | + |
295 | +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java |
296 | +# sources only. Doxygen will then generate output that is more tailored for |
297 | +# Java. For instance, namespaces will be presented as packages, qualified |
298 | +# scopes will look different, etc. |
299 | + |
300 | +OPTIMIZE_OUTPUT_JAVA = NO |
301 | + |
302 | +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran |
303 | +# sources only. Doxygen will then generate output that is more tailored for |
304 | +# Fortran. |
305 | + |
306 | +OPTIMIZE_FOR_FORTRAN = NO |
307 | + |
308 | +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL |
309 | +# sources. Doxygen will then generate output that is tailored for |
310 | +# VHDL. |
311 | + |
312 | +OPTIMIZE_OUTPUT_VHDL = NO |
313 | + |
314 | +# Doxygen selects the parser to use depending on the extension of the files it |
315 | +# parses. With this tag you can assign which parser to use for a given extension. |
316 | +# Doxygen has a built-in mapping, but you can override or extend it using this |
317 | +# tag. The format is ext=language, where ext is a file extension, and language |
318 | +# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C, |
319 | +# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make |
320 | +# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C |
321 | +# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions |
322 | +# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. |
323 | + |
324 | +EXTENSION_MAPPING = |
325 | + |
326 | +# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all |
327 | +# comments according to the Markdown format, which allows for more readable |
328 | +# documentation. See http://daringfireball.net/projects/markdown/ for details. |
329 | +# The output of markdown processing is further processed by doxygen, so you |
330 | +# can mix doxygen, HTML, and XML commands with Markdown formatting. |
331 | +# Disable only in case of backward compatibilities issues. |
332 | + |
333 | +MARKDOWN_SUPPORT = YES |
334 | + |
335 | +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want |
336 | +# to include (a tag file for) the STL sources as input, then you should |
337 | +# set this tag to YES in order to let doxygen match functions declarations and |
338 | +# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. |
339 | +# func(std::string) {}). This also makes the inheritance and collaboration |
340 | +# diagrams that involve STL classes more complete and accurate. |
341 | + |
342 | +BUILTIN_STL_SUPPORT = NO |
343 | + |
344 | +# If you use Microsoft's C++/CLI language, you should set this option to YES to |
345 | +# enable parsing support. |
346 | + |
347 | +CPP_CLI_SUPPORT = NO |
348 | + |
349 | +# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. |
350 | +# Doxygen will parse them like normal C++ but will assume all classes use public |
351 | +# instead of private inheritance when no explicit protection keyword is present. |
352 | + |
353 | +SIP_SUPPORT = NO |
354 | + |
355 | +# For Microsoft's IDL there are propget and propput attributes to indicate getter |
356 | +# and setter methods for a property. Setting this option to YES (the default) |
357 | +# will make doxygen replace the get and set methods by a property in the |
358 | +# documentation. This will only work if the methods are indeed getting or |
359 | +# setting a simple type. If this is not the case, or you want to show the |
360 | +# methods anyway, you should set this option to NO. |
361 | + |
362 | +IDL_PROPERTY_SUPPORT = YES |
363 | + |
364 | +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC |
365 | +# tag is set to YES, then doxygen will reuse the documentation of the first |
366 | +# member in the group (if any) for the other members of the group. By default |
367 | +# all members of a group must be documented explicitly. |
368 | + |
369 | +DISTRIBUTE_GROUP_DOC = NO |
370 | + |
371 | +# Set the SUBGROUPING tag to YES (the default) to allow class member groups of |
372 | +# the same type (for instance a group of public functions) to be put as a |
373 | +# subgroup of that type (e.g. under the Public Functions section). Set it to |
374 | +# NO to prevent subgrouping. Alternatively, this can be done per class using |
375 | +# the \nosubgrouping command. |
376 | + |
377 | +SUBGROUPING = YES |
378 | + |
379 | +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and |
380 | +# unions are shown inside the group in which they are included (e.g. using |
381 | +# @ingroup) instead of on a separate page (for HTML and Man pages) or |
382 | +# section (for LaTeX and RTF). |
383 | + |
384 | +INLINE_GROUPED_CLASSES = NO |
385 | + |
386 | +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and |
387 | +# unions with only public data fields will be shown inline in the documentation |
388 | +# of the scope in which they are defined (i.e. file, namespace, or group |
389 | +# documentation), provided this scope is documented. If set to NO (the default), |
390 | +# structs, classes, and unions are shown on a separate page (for HTML and Man |
391 | +# pages) or section (for LaTeX and RTF). |
392 | + |
393 | +INLINE_SIMPLE_STRUCTS = NO |
394 | + |
395 | +# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum |
396 | +# is documented as struct, union, or enum with the name of the typedef. So |
397 | +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct |
398 | +# with name TypeT. When disabled the typedef will appear as a member of a file, |
399 | +# namespace, or class. And the struct will be named TypeS. This can typically |
400 | +# be useful for C code in case the coding convention dictates that all compound |
401 | +# types are typedef'ed and only the typedef is referenced, never the tag name. |
402 | + |
403 | +TYPEDEF_HIDES_STRUCT = NO |
404 | + |
405 | +# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to |
406 | +# determine which symbols to keep in memory and which to flush to disk. |
407 | +# When the cache is full, less often used symbols will be written to disk. |
408 | +# For small to medium size projects (<1000 input files) the default value is |
409 | +# probably good enough. For larger projects a too small cache size can cause |
410 | +# doxygen to be busy swapping symbols to and from disk most of the time |
411 | +# causing a significant performance penalty. |
412 | +# If the system has enough physical memory increasing the cache will improve the |
413 | +# performance by keeping more symbols in memory. Note that the value works on |
414 | +# a logarithmic scale so increasing the size by one will roughly double the |
415 | +# memory usage. The cache size is given by this formula: |
416 | +# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, |
417 | +# corresponding to a cache size of 2^16 = 65536 symbols. |
418 | + |
419 | +SYMBOL_CACHE_SIZE = 0 |
420 | + |
421 | +# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be |
422 | +# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given |
423 | +# their name and scope. Since this can be an expensive process and often the |
424 | +# same symbol appear multiple times in the code, doxygen keeps a cache of |
425 | +# pre-resolved symbols. If the cache is too small doxygen will become slower. |
426 | +# If the cache is too large, memory is wasted. The cache size is given by this |
427 | +# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0, |
428 | +# corresponding to a cache size of 2^16 = 65536 symbols. |
429 | + |
430 | +LOOKUP_CACHE_SIZE = 0 |
431 | + |
432 | +#--------------------------------------------------------------------------- |
433 | +# Build related configuration options |
434 | +#--------------------------------------------------------------------------- |
435 | + |
436 | +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in |
437 | +# documentation are documented, even if no documentation was available. |
438 | +# Private class members and static file members will be hidden unless |
439 | +# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES |
440 | + |
441 | +EXTRACT_ALL = NO |
442 | + |
443 | +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class |
444 | +# will be included in the documentation. |
445 | + |
446 | +EXTRACT_PRIVATE = NO |
447 | + |
448 | +# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal |
449 | +# scope will be included in the documentation. |
450 | + |
451 | +EXTRACT_PACKAGE = NO |
452 | + |
453 | +# If the EXTRACT_STATIC tag is set to YES all static members of a file |
454 | +# will be included in the documentation. |
455 | + |
456 | +EXTRACT_STATIC = NO |
457 | + |
458 | +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) |
459 | +# defined locally in source files will be included in the documentation. |
460 | +# If set to NO only classes defined in header files are included. |
461 | + |
462 | +EXTRACT_LOCAL_CLASSES = YES |
463 | + |
464 | +# This flag is only useful for Objective-C code. When set to YES local |
465 | +# methods, which are defined in the implementation section but not in |
466 | +# the interface are included in the documentation. |
467 | +# If set to NO (the default) only methods in the interface are included. |
468 | + |
469 | +EXTRACT_LOCAL_METHODS = NO |
470 | + |
471 | +# If this flag is set to YES, the members of anonymous namespaces will be |
472 | +# extracted and appear in the documentation as a namespace called |
473 | +# 'anonymous_namespace{file}', where file will be replaced with the base |
474 | +# name of the file that contains the anonymous namespace. By default |
475 | +# anonymous namespaces are hidden. |
476 | + |
477 | +EXTRACT_ANON_NSPACES = NO |
478 | + |
479 | +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all |
480 | +# undocumented members of documented classes, files or namespaces. |
481 | +# If set to NO (the default) these members will be included in the |
482 | +# various overviews, but no documentation section is generated. |
483 | +# This option has no effect if EXTRACT_ALL is enabled. |
484 | + |
485 | +HIDE_UNDOC_MEMBERS = NO |
486 | + |
487 | +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all |
488 | +# undocumented classes that are normally visible in the class hierarchy. |
489 | +# If set to NO (the default) these classes will be included in the various |
490 | +# overviews. This option has no effect if EXTRACT_ALL is enabled. |
491 | + |
492 | +HIDE_UNDOC_CLASSES = NO |
493 | + |
494 | +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all |
495 | +# friend (class|struct|union) declarations. |
496 | +# If set to NO (the default) these declarations will be included in the |
497 | +# documentation. |
498 | + |
499 | +HIDE_FRIEND_COMPOUNDS = NO |
500 | + |
501 | +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any |
502 | +# documentation blocks found inside the body of a function. |
503 | +# If set to NO (the default) these blocks will be appended to the |
504 | +# function's detailed documentation block. |
505 | + |
506 | +HIDE_IN_BODY_DOCS = NO |
507 | + |
508 | +# The INTERNAL_DOCS tag determines if documentation |
509 | +# that is typed after a \internal command is included. If the tag is set |
510 | +# to NO (the default) then the documentation will be excluded. |
511 | +# Set it to YES to include the internal documentation. |
512 | + |
513 | +INTERNAL_DOCS = NO |
514 | + |
515 | +# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate |
516 | +# file names in lower-case letters. If set to YES upper-case letters are also |
517 | +# allowed. This is useful if you have classes or files whose names only differ |
518 | +# in case and if your file system supports case sensitive file names. Windows |
519 | +# and Mac users are advised to set this option to NO. |
520 | + |
521 | +CASE_SENSE_NAMES = NO |
522 | + |
523 | +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen |
524 | +# will show members with their full class and namespace scopes in the |
525 | +# documentation. If set to YES the scope will be hidden. |
526 | + |
527 | +HIDE_SCOPE_NAMES = NO |
528 | + |
529 | +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen |
530 | +# will put a list of the files that are included by a file in the documentation |
531 | +# of that file. |
532 | + |
533 | +SHOW_INCLUDE_FILES = YES |
534 | + |
535 | +# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen |
536 | +# will list include files with double quotes in the documentation |
537 | +# rather than with sharp brackets. |
538 | + |
539 | +FORCE_LOCAL_INCLUDES = NO |
540 | + |
541 | +# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] |
542 | +# is inserted in the documentation for inline members. |
543 | + |
544 | +INLINE_INFO = YES |
545 | + |
546 | +# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen |
547 | +# will sort the (detailed) documentation of file and class members |
548 | +# alphabetically by member name. If set to NO the members will appear in |
549 | +# declaration order. |
550 | + |
551 | +SORT_MEMBER_DOCS = YES |
552 | + |
553 | +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the |
554 | +# brief documentation of file, namespace and class members alphabetically |
555 | +# by member name. If set to NO (the default) the members will appear in |
556 | +# declaration order. |
557 | + |
558 | +SORT_BRIEF_DOCS = NO |
559 | + |
560 | +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen |
561 | +# will sort the (brief and detailed) documentation of class members so that |
562 | +# constructors and destructors are listed first. If set to NO (the default) |
563 | +# the constructors will appear in the respective orders defined by |
564 | +# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. |
565 | +# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO |
566 | +# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. |
567 | + |
568 | +SORT_MEMBERS_CTORS_1ST = NO |
569 | + |
570 | +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the |
571 | +# hierarchy of group names into alphabetical order. If set to NO (the default) |
572 | +# the group names will appear in their defined order. |
573 | + |
574 | +SORT_GROUP_NAMES = NO |
575 | + |
576 | +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be |
577 | +# sorted by fully-qualified names, including namespaces. If set to |
578 | +# NO (the default), the class list will be sorted only by class name, |
579 | +# not including the namespace part. |
580 | +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. |
581 | +# Note: This option applies only to the class list, not to the |
582 | +# alphabetical list. |
583 | + |
584 | +SORT_BY_SCOPE_NAME = NO |
585 | + |
586 | +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to |
587 | +# do proper type resolution of all parameters of a function it will reject a |
588 | +# match between the prototype and the implementation of a member function even |
589 | +# if there is only one candidate or it is obvious which candidate to choose |
590 | +# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen |
591 | +# will still accept a match between prototype and implementation in such cases. |
592 | + |
593 | +STRICT_PROTO_MATCHING = NO |
594 | + |
595 | +# The GENERATE_TODOLIST tag can be used to enable (YES) or |
596 | +# disable (NO) the todo list. This list is created by putting \todo |
597 | +# commands in the documentation. |
598 | + |
599 | +GENERATE_TODOLIST = YES |
600 | + |
601 | +# The GENERATE_TESTLIST tag can be used to enable (YES) or |
602 | +# disable (NO) the test list. This list is created by putting \test |
603 | +# commands in the documentation. |
604 | + |
605 | +GENERATE_TESTLIST = YES |
606 | + |
607 | +# The GENERATE_BUGLIST tag can be used to enable (YES) or |
608 | +# disable (NO) the bug list. This list is created by putting \bug |
609 | +# commands in the documentation. |
610 | + |
611 | +GENERATE_BUGLIST = YES |
612 | + |
613 | +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or |
614 | +# disable (NO) the deprecated list. This list is created by putting |
615 | +# \deprecated commands in the documentation. |
616 | + |
617 | +GENERATE_DEPRECATEDLIST= YES |
618 | + |
619 | +# The ENABLED_SECTIONS tag can be used to enable conditional |
620 | +# documentation sections, marked by \if sectionname ... \endif. |
621 | + |
622 | +ENABLED_SECTIONS = |
623 | + |
624 | +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines |
625 | +# the initial value of a variable or macro consists of for it to appear in |
626 | +# the documentation. If the initializer consists of more lines than specified |
627 | +# here it will be hidden. Use a value of 0 to hide initializers completely. |
628 | +# The appearance of the initializer of individual variables and macros in the |
629 | +# documentation can be controlled using \showinitializer or \hideinitializer |
630 | +# command in the documentation regardless of this setting. |
631 | + |
632 | +MAX_INITIALIZER_LINES = 30 |
633 | + |
634 | +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated |
635 | +# at the bottom of the documentation of classes and structs. If set to YES the |
636 | +# list will mention the files that were used to generate the documentation. |
637 | + |
638 | +SHOW_USED_FILES = YES |
639 | + |
640 | +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. |
641 | +# This will remove the Files entry from the Quick Index and from the |
642 | +# Folder Tree View (if specified). The default is YES. |
643 | + |
644 | +SHOW_FILES = YES |
645 | + |
646 | +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the |
647 | +# Namespaces page. This will remove the Namespaces entry from the Quick Index |
648 | +# and from the Folder Tree View (if specified). The default is YES. |
649 | + |
650 | +SHOW_NAMESPACES = YES |
651 | + |
652 | +# The FILE_VERSION_FILTER tag can be used to specify a program or script that |
653 | +# doxygen should invoke to get the current version for each file (typically from |
654 | +# the version control system). Doxygen will invoke the program by executing (via |
655 | +# popen()) the command <command> <input-file>, where <command> is the value of |
656 | +# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file |
657 | +# provided by doxygen. Whatever the program writes to standard output |
658 | +# is used as the file version. See the manual for examples. |
659 | + |
660 | +FILE_VERSION_FILTER = |
661 | + |
662 | +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed |
663 | +# by doxygen. The layout file controls the global structure of the generated |
664 | +# output files in an output format independent way. To create the layout file |
665 | +# that represents doxygen's defaults, run doxygen with the -l option. |
666 | +# You can optionally specify a file name after the option, if omitted |
667 | +# DoxygenLayout.xml will be used as the name of the layout file. |
668 | + |
669 | +LAYOUT_FILE = |
670 | + |
671 | +# The CITE_BIB_FILES tag can be used to specify one or more bib files |
672 | +# containing the references data. This must be a list of .bib files. The |
673 | +# .bib extension is automatically appended if omitted. Using this command |
674 | +# requires the bibtex tool to be installed. See also |
675 | +# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style |
676 | +# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this |
677 | +# feature you need bibtex and perl available in the search path. |
678 | + |
679 | +CITE_BIB_FILES = |
680 | + |
681 | +#--------------------------------------------------------------------------- |
682 | +# configuration options related to warning and progress messages |
683 | +#--------------------------------------------------------------------------- |
684 | + |
685 | +# The QUIET tag can be used to turn on/off the messages that are generated |
686 | +# by doxygen. Possible values are YES and NO. If left blank NO is used. |
687 | + |
688 | +QUIET = YES |
689 | + |
690 | +# The WARNINGS tag can be used to turn on/off the warning messages that are |
691 | +# generated by doxygen. Possible values are YES and NO. If left blank |
692 | +# NO is used. |
693 | + |
694 | +WARNINGS = YES |
695 | + |
696 | +# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings |
697 | +# for undocumented members. If EXTRACT_ALL is set to YES then this flag will |
698 | +# automatically be disabled. |
699 | + |
700 | +WARN_IF_UNDOCUMENTED = YES |
701 | + |
702 | +# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for |
703 | +# potential errors in the documentation, such as not documenting some |
704 | +# parameters in a documented function, or documenting parameters that |
705 | +# don't exist or using markup commands wrongly. |
706 | + |
707 | +WARN_IF_DOC_ERROR = YES |
708 | + |
709 | +# The WARN_NO_PARAMDOC option can be enabled to get warnings for |
710 | +# functions that are documented, but have no documentation for their parameters |
711 | +# or return value. If set to NO (the default) doxygen will only warn about |
712 | +# wrong or incomplete parameter documentation, but not about the absence of |
713 | +# documentation. |
714 | + |
715 | +WARN_NO_PARAMDOC = NO |
716 | + |
717 | +# The WARN_FORMAT tag determines the format of the warning messages that |
718 | +# doxygen can produce. The string should contain the $file, $line, and $text |
719 | +# tags, which will be replaced by the file and line number from which the |
720 | +# warning originated and the warning text. Optionally the format may contain |
721 | +# $version, which will be replaced by the version of the file (if it could |
722 | +# be obtained via FILE_VERSION_FILTER) |
723 | + |
724 | +WARN_FORMAT = "$file:$line: $text" |
725 | + |
726 | +# The WARN_LOGFILE tag can be used to specify a file to which warning |
727 | +# and error messages should be written. If left blank the output is written |
728 | +# to stderr. |
729 | + |
730 | +WARN_LOGFILE = |
731 | + |
732 | +#--------------------------------------------------------------------------- |
733 | +# configuration options related to the input files |
734 | +#--------------------------------------------------------------------------- |
735 | + |
736 | +# The INPUT tag can be used to specify the files and/or directories that contain |
737 | +# documented source files. You may enter file names like "myfile.cpp" or |
738 | +# directories like "/usr/src/myproject". Separate the files or directories |
739 | +# with spaces. |
740 | + |
741 | +INPUT = @PROJECT_BINARY_DIR@/include @PROJECT_SOURCE_DIR@/include @PROJECT_SOURCE_DIR@/src |
742 | + |
743 | +# This tag can be used to specify the character encoding of the source files |
744 | +# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is |
745 | +# also the default input encoding. Doxygen uses libiconv (or the iconv built |
746 | +# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for |
747 | +# the list of possible encodings. |
748 | + |
749 | +INPUT_ENCODING = UTF-8 |
750 | + |
751 | +# If the value of the INPUT tag contains directories, you can use the |
752 | +# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp |
753 | +# and *.h) to filter out the source-files in the directories. If left |
754 | +# blank the following patterns are tested: |
755 | +# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh |
756 | +# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py |
757 | +# *.f90 *.f *.for *.vhd *.vhdl |
758 | + |
759 | +FILE_PATTERNS = *.c \ |
760 | + *.cc \ |
761 | + *.cxx \ |
762 | + *.cpp \ |
763 | + *.c++ \ |
764 | + *.d \ |
765 | + *.java \ |
766 | + *.ii \ |
767 | + *.ixx \ |
768 | + *.ipp \ |
769 | + *.i++ \ |
770 | + *.inl \ |
771 | + *.h \ |
772 | + *.hh \ |
773 | + *.hxx \ |
774 | + *.hpp \ |
775 | + *.h++ \ |
776 | + *.idl \ |
777 | + *.odl \ |
778 | + *.cs \ |
779 | + *.php \ |
780 | + *.php3 \ |
781 | + *.inc \ |
782 | + *.m \ |
783 | + *.markdown \ |
784 | + *.md \ |
785 | + *.mm \ |
786 | + *.dox \ |
787 | + *.py \ |
788 | + *.f90 \ |
789 | + *.f \ |
790 | + *.for \ |
791 | + *.vhd \ |
792 | + *.vhdl |
793 | + |
794 | +# The RECURSIVE tag can be used to turn specify whether or not subdirectories |
795 | +# should be searched for input files as well. Possible values are YES and NO. |
796 | +# If left blank NO is used. |
797 | + |
798 | +RECURSIVE = YES |
799 | + |
800 | +# The EXCLUDE tag can be used to specify files and/or directories that should be |
801 | +# excluded from the INPUT source files. This way you can easily exclude a |
802 | +# subdirectory from a directory tree whose root is specified with the INPUT tag. |
803 | +# Note that relative paths are relative to the directory from which doxygen is |
804 | +# run. |
805 | + |
806 | +EXCLUDE = |
807 | + |
808 | +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or |
809 | +# directories that are symbolic links (a Unix file system feature) are excluded |
810 | +# from the input. |
811 | + |
812 | +EXCLUDE_SYMLINKS = NO |
813 | + |
814 | +# If the value of the INPUT tag contains directories, you can use the |
815 | +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude |
816 | +# certain files from those directories. Note that the wildcards are matched |
817 | +# against the file with absolute path, so to exclude all test directories |
818 | +# for example use the pattern */test/* |
819 | + |
820 | +EXCLUDE_PATTERNS = */internal/* |
821 | + |
822 | +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names |
823 | +# (namespaces, classes, functions, etc.) that should be excluded from the |
824 | +# output. The symbol name can be a fully qualified name, a word, or if the |
825 | +# wildcard * is used, a substring. Examples: ANamespace, AClass, |
826 | +# AClass::ANamespace, ANamespace::*Test |
827 | + |
828 | +EXCLUDE_SYMBOLS = |
829 | + |
830 | +# The EXAMPLE_PATH tag can be used to specify one or more files or |
831 | +# directories that contain example code fragments that are included (see |
832 | +# the \include command). |
833 | + |
834 | +EXAMPLE_PATH = |
835 | + |
836 | +# If the value of the EXAMPLE_PATH tag contains directories, you can use the |
837 | +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp |
838 | +# and *.h) to filter out the source-files in the directories. If left |
839 | +# blank all files are included. |
840 | + |
841 | +EXAMPLE_PATTERNS = * |
842 | + |
843 | +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be |
844 | +# searched for input files to be used with the \include or \dontinclude |
845 | +# commands irrespective of the value of the RECURSIVE tag. |
846 | +# Possible values are YES and NO. If left blank NO is used. |
847 | + |
848 | +EXAMPLE_RECURSIVE = NO |
849 | + |
850 | +# The IMAGE_PATH tag can be used to specify one or more files or |
851 | +# directories that contain image that are included in the documentation (see |
852 | +# the \image command). |
853 | + |
854 | +IMAGE_PATH = |
855 | + |
856 | +# The INPUT_FILTER tag can be used to specify a program that doxygen should |
857 | +# invoke to filter for each input file. Doxygen will invoke the filter program |
858 | +# by executing (via popen()) the command <filter> <input-file>, where <filter> |
859 | +# is the value of the INPUT_FILTER tag, and <input-file> is the name of an |
860 | +# input file. Doxygen will then use the output that the filter program writes |
861 | +# to standard output. If FILTER_PATTERNS is specified, this tag will be |
862 | +# ignored. |
863 | + |
864 | +INPUT_FILTER = |
865 | + |
866 | +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern |
867 | +# basis. Doxygen will compare the file name with each pattern and apply the |
868 | +# filter if there is a match. The filters are a list of the form: |
869 | +# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further |
870 | +# info on how filters are used. If FILTER_PATTERNS is empty or if |
871 | +# non of the patterns match the file name, INPUT_FILTER is applied. |
872 | + |
873 | +FILTER_PATTERNS = |
874 | + |
875 | +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using |
876 | +# INPUT_FILTER) will be used to filter the input files when producing source |
877 | +# files to browse (i.e. when SOURCE_BROWSER is set to YES). |
878 | + |
879 | +FILTER_SOURCE_FILES = NO |
880 | + |
881 | +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file |
882 | +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) |
883 | +# and it is also possible to disable source filtering for a specific pattern |
884 | +# using *.ext= (so without naming a filter). This option only has effect when |
885 | +# FILTER_SOURCE_FILES is enabled. |
886 | + |
887 | +FILTER_SOURCE_PATTERNS = |
888 | + |
889 | +#--------------------------------------------------------------------------- |
890 | +# configuration options related to source browsing |
891 | +#--------------------------------------------------------------------------- |
892 | + |
893 | +# If the SOURCE_BROWSER tag is set to YES then a list of source files will |
894 | +# be generated. Documented entities will be cross-referenced with these sources. |
895 | +# Note: To get rid of all source code in the generated output, make sure also |
896 | +# VERBATIM_HEADERS is set to NO. |
897 | + |
898 | +SOURCE_BROWSER = NO |
899 | + |
900 | +# Setting the INLINE_SOURCES tag to YES will include the body |
901 | +# of functions and classes directly in the documentation. |
902 | + |
903 | +INLINE_SOURCES = NO |
904 | + |
905 | +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct |
906 | +# doxygen to hide any special comment blocks from generated source code |
907 | +# fragments. Normal C, C++ and Fortran comments will always remain visible. |
908 | + |
909 | +STRIP_CODE_COMMENTS = YES |
910 | + |
911 | +# If the REFERENCED_BY_RELATION tag is set to YES |
912 | +# then for each documented function all documented |
913 | +# functions referencing it will be listed. |
914 | + |
915 | +REFERENCED_BY_RELATION = NO |
916 | + |
917 | +# If the REFERENCES_RELATION tag is set to YES |
918 | +# then for each documented function all documented entities |
919 | +# called/used by that function will be listed. |
920 | + |
921 | +REFERENCES_RELATION = NO |
922 | + |
923 | +# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) |
924 | +# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from |
925 | +# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will |
926 | +# link to the source code. Otherwise they will link to the documentation. |
927 | + |
928 | +REFERENCES_LINK_SOURCE = YES |
929 | + |
930 | +# If the USE_HTAGS tag is set to YES then the references to source code |
931 | +# will point to the HTML generated by the htags(1) tool instead of doxygen |
932 | +# built-in source browser. The htags tool is part of GNU's global source |
933 | +# tagging system (see http://www.gnu.org/software/global/global.html). You |
934 | +# will need version 4.8.6 or higher. |
935 | + |
936 | +USE_HTAGS = NO |
937 | + |
938 | +# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen |
939 | +# will generate a verbatim copy of the header file for each class for |
940 | +# which an include is specified. Set to NO to disable this. |
941 | + |
942 | +VERBATIM_HEADERS = YES |
943 | + |
944 | +#--------------------------------------------------------------------------- |
945 | +# configuration options related to the alphabetical class index |
946 | +#--------------------------------------------------------------------------- |
947 | + |
948 | +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index |
949 | +# of all compounds will be generated. Enable this if the project |
950 | +# contains a lot of classes, structs, unions or interfaces. |
951 | + |
952 | +ALPHABETICAL_INDEX = YES |
953 | + |
954 | +# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then |
955 | +# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns |
956 | +# in which this list will be split (can be a number in the range [1..20]) |
957 | + |
958 | +COLS_IN_ALPHA_INDEX = 5 |
959 | + |
960 | +# In case all classes in a project start with a common prefix, all |
961 | +# classes will be put under the same header in the alphabetical index. |
962 | +# The IGNORE_PREFIX tag can be used to specify one or more prefixes that |
963 | +# should be ignored while generating the index headers. |
964 | + |
965 | +IGNORE_PREFIX = |
966 | + |
967 | +#--------------------------------------------------------------------------- |
968 | +# configuration options related to the HTML output |
969 | +#--------------------------------------------------------------------------- |
970 | + |
971 | +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will |
972 | +# generate HTML output. |
973 | + |
974 | +GENERATE_HTML = YES |
975 | + |
976 | +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. |
977 | +# If a relative path is entered the value of OUTPUT_DIRECTORY will be |
978 | +# put in front of it. If left blank `html' will be used as the default path. |
979 | + |
980 | +HTML_OUTPUT = lib@UNITY_API_LIB@ |
981 | + |
982 | +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for |
983 | +# each generated HTML page (for example: .htm,.php,.asp). If it is left blank |
984 | +# doxygen will generate files with .html extension. |
985 | + |
986 | +HTML_FILE_EXTENSION = .html |
987 | + |
988 | +# The HTML_HEADER tag can be used to specify a personal HTML header for |
989 | +# each generated HTML page. If it is left blank doxygen will generate a |
990 | +# standard header. Note that when using a custom header you are responsible |
991 | +# for the proper inclusion of any scripts and style sheets that doxygen |
992 | +# needs, which is dependent on the configuration options used. |
993 | +# It is advised to generate a default header using "doxygen -w html |
994 | +# header.html footer.html stylesheet.css YourConfigFile" and then modify |
995 | +# that header. Note that the header is subject to change so you typically |
996 | +# have to redo this when upgrading to a newer version of doxygen or when |
997 | +# changing the value of configuration settings such as GENERATE_TREEVIEW! |
998 | + |
999 | +HTML_HEADER = |
1000 | + |
1001 | +# The HTML_FOOTER tag can be used to specify a personal HTML footer for |
1002 | +# each generated HTML page. If it is left blank doxygen will generate a |
1003 | +# standard footer. |
1004 | + |
1005 | +HTML_FOOTER = |
1006 | + |
1007 | +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading |
1008 | +# style sheet that is used by each HTML page. It can be used to |
1009 | +# fine-tune the look of the HTML output. If the tag is left blank doxygen |
1010 | +# will generate a default style sheet. Note that doxygen will try to copy |
1011 | +# the style sheet file to the HTML output directory, so don't put your own |
1012 | +# style sheet in the HTML output directory as well, or it will be erased! |
1013 | + |
1014 | +HTML_STYLESHEET = |
1015 | + |
1016 | +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or |
1017 | +# other source files which should be copied to the HTML output directory. Note |
1018 | +# that these files will be copied to the base HTML output directory. Use the |
1019 | +# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these |
1020 | +# files. In the HTML_STYLESHEET file, use the file name only. Also note that |
1021 | +# the files will be copied as-is; there are no commands or markers available. |
1022 | + |
1023 | +HTML_EXTRA_FILES = |
1024 | + |
1025 | +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. |
1026 | +# Doxygen will adjust the colors in the style sheet and background images |
1027 | +# according to this color. Hue is specified as an angle on a colorwheel, |
1028 | +# see http://en.wikipedia.org/wiki/Hue for more information. |
1029 | +# For instance the value 0 represents red, 60 is yellow, 120 is green, |
1030 | +# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. |
1031 | +# The allowed range is 0 to 359. |
1032 | + |
1033 | +HTML_COLORSTYLE_HUE = 220 |
1034 | + |
1035 | +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of |
1036 | +# the colors in the HTML output. For a value of 0 the output will use |
1037 | +# grayscales only. A value of 255 will produce the most vivid colors. |
1038 | + |
1039 | +HTML_COLORSTYLE_SAT = 100 |
1040 | + |
1041 | +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to |
1042 | +# the luminance component of the colors in the HTML output. Values below |
1043 | +# 100 gradually make the output lighter, whereas values above 100 make |
1044 | +# the output darker. The value divided by 100 is the actual gamma applied, |
1045 | +# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, |
1046 | +# and 100 does not change the gamma. |
1047 | + |
1048 | +HTML_COLORSTYLE_GAMMA = 80 |
1049 | + |
1050 | +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML |
1051 | +# page will contain the date and time when the page was generated. Setting |
1052 | +# this to NO can help when comparing the output of multiple runs. |
1053 | + |
1054 | +HTML_TIMESTAMP = YES |
1055 | + |
1056 | +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML |
1057 | +# documentation will contain sections that can be hidden and shown after the |
1058 | +# page has loaded. |
1059 | + |
1060 | +HTML_DYNAMIC_SECTIONS = NO |
1061 | + |
1062 | +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of |
1063 | +# entries shown in the various tree structured indices initially; the user |
1064 | +# can expand and collapse entries dynamically later on. Doxygen will expand |
1065 | +# the tree to such a level that at most the specified number of entries are |
1066 | +# visible (unless a fully collapsed tree already exceeds this amount). |
1067 | +# So setting the number of entries 1 will produce a full collapsed tree by |
1068 | +# default. 0 is a special value representing an infinite number of entries |
1069 | +# and will result in a full expanded tree by default. |
1070 | + |
1071 | +HTML_INDEX_NUM_ENTRIES = 100 |
1072 | + |
1073 | +# If the GENERATE_DOCSET tag is set to YES, additional index files |
1074 | +# will be generated that can be used as input for Apple's Xcode 3 |
1075 | +# integrated development environment, introduced with OSX 10.5 (Leopard). |
1076 | +# To create a documentation set, doxygen will generate a Makefile in the |
1077 | +# HTML output directory. Running make will produce the docset in that |
1078 | +# directory and running "make install" will install the docset in |
1079 | +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find |
1080 | +# it at startup. |
1081 | +# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html |
1082 | +# for more information. |
1083 | + |
1084 | +GENERATE_DOCSET = NO |
1085 | + |
1086 | +# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the |
1087 | +# feed. A documentation feed provides an umbrella under which multiple |
1088 | +# documentation sets from a single provider (such as a company or product suite) |
1089 | +# can be grouped. |
1090 | + |
1091 | +DOCSET_FEEDNAME = "Doxygen generated docs" |
1092 | + |
1093 | +# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that |
1094 | +# should uniquely identify the documentation set bundle. This should be a |
1095 | +# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen |
1096 | +# will append .docset to the name. |
1097 | + |
1098 | +DOCSET_BUNDLE_ID = org.doxygen.Project |
1099 | + |
1100 | +# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify |
1101 | +# the documentation publisher. This should be a reverse domain-name style |
1102 | +# string, e.g. com.mycompany.MyDocSet.documentation. |
1103 | + |
1104 | +DOCSET_PUBLISHER_ID = org.doxygen.Publisher |
1105 | + |
1106 | +# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. |
1107 | + |
1108 | +DOCSET_PUBLISHER_NAME = Publisher |
1109 | + |
1110 | +# If the GENERATE_HTMLHELP tag is set to YES, additional index files |
1111 | +# will be generated that can be used as input for tools like the |
1112 | +# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) |
1113 | +# of the generated HTML documentation. |
1114 | + |
1115 | +GENERATE_HTMLHELP = NO |
1116 | + |
1117 | +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can |
1118 | +# be used to specify the file name of the resulting .chm file. You |
1119 | +# can add a path in front of the file if the result should not be |
1120 | +# written to the html output directory. |
1121 | + |
1122 | +CHM_FILE = |
1123 | + |
1124 | +# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can |
1125 | +# be used to specify the location (absolute path including file name) of |
1126 | +# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run |
1127 | +# the HTML help compiler on the generated index.hhp. |
1128 | + |
1129 | +HHC_LOCATION = |
1130 | + |
1131 | +# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag |
1132 | +# controls if a separate .chi index file is generated (YES) or that |
1133 | +# it should be included in the master .chm file (NO). |
1134 | + |
1135 | +GENERATE_CHI = NO |
1136 | + |
1137 | +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING |
1138 | +# is used to encode HtmlHelp index (hhk), content (hhc) and project file |
1139 | +# content. |
1140 | + |
1141 | +CHM_INDEX_ENCODING = |
1142 | + |
1143 | +# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag |
1144 | +# controls whether a binary table of contents is generated (YES) or a |
1145 | +# normal table of contents (NO) in the .chm file. |
1146 | + |
1147 | +BINARY_TOC = NO |
1148 | + |
1149 | +# The TOC_EXPAND flag can be set to YES to add extra items for group members |
1150 | +# to the contents of the HTML help documentation and to the tree view. |
1151 | + |
1152 | +TOC_EXPAND = NO |
1153 | + |
1154 | +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and |
1155 | +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated |
1156 | +# that can be used as input for Qt's qhelpgenerator to generate a |
1157 | +# Qt Compressed Help (.qch) of the generated HTML documentation. |
1158 | + |
1159 | +GENERATE_QHP = NO |
1160 | + |
1161 | +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can |
1162 | +# be used to specify the file name of the resulting .qch file. |
1163 | +# The path specified is relative to the HTML output folder. |
1164 | + |
1165 | +QCH_FILE = |
1166 | + |
1167 | +# The QHP_NAMESPACE tag specifies the namespace to use when generating |
1168 | +# Qt Help Project output. For more information please see |
1169 | +# http://doc.trolltech.com/qthelpproject.html#namespace |
1170 | + |
1171 | +QHP_NAMESPACE = org.doxygen.Project |
1172 | + |
1173 | +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating |
1174 | +# Qt Help Project output. For more information please see |
1175 | +# http://doc.trolltech.com/qthelpproject.html#virtual-folders |
1176 | + |
1177 | +QHP_VIRTUAL_FOLDER = doc |
1178 | + |
1179 | +# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to |
1180 | +# add. For more information please see |
1181 | +# http://doc.trolltech.com/qthelpproject.html#custom-filters |
1182 | + |
1183 | +QHP_CUST_FILTER_NAME = |
1184 | + |
1185 | +# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the |
1186 | +# custom filter to add. For more information please see |
1187 | +# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters"> |
1188 | +# Qt Help Project / Custom Filters</a>. |
1189 | + |
1190 | +QHP_CUST_FILTER_ATTRS = |
1191 | + |
1192 | +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this |
1193 | +# project's |
1194 | +# filter section matches. |
1195 | +# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes"> |
1196 | +# Qt Help Project / Filter Attributes</a>. |
1197 | + |
1198 | +QHP_SECT_FILTER_ATTRS = |
1199 | + |
1200 | +# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can |
1201 | +# be used to specify the location of Qt's qhelpgenerator. |
1202 | +# If non-empty doxygen will try to run qhelpgenerator on the generated |
1203 | +# .qhp file. |
1204 | + |
1205 | +QHG_LOCATION = |
1206 | + |
1207 | +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files |
1208 | +# will be generated, which together with the HTML files, form an Eclipse help |
1209 | +# plugin. To install this plugin and make it available under the help contents |
1210 | +# menu in Eclipse, the contents of the directory containing the HTML and XML |
1211 | +# files needs to be copied into the plugins directory of eclipse. The name of |
1212 | +# the directory within the plugins directory should be the same as |
1213 | +# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before |
1214 | +# the help appears. |
1215 | + |
1216 | +GENERATE_ECLIPSEHELP = NO |
1217 | + |
1218 | +# A unique identifier for the eclipse help plugin. When installing the plugin |
1219 | +# the directory name containing the HTML and XML files should also have |
1220 | +# this name. |
1221 | + |
1222 | +ECLIPSE_DOC_ID = org.doxygen.Project |
1223 | + |
1224 | +# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) |
1225 | +# at top of each HTML page. The value NO (the default) enables the index and |
1226 | +# the value YES disables it. Since the tabs have the same information as the |
1227 | +# navigation tree you can set this option to NO if you already set |
1228 | +# GENERATE_TREEVIEW to YES. |
1229 | + |
1230 | +DISABLE_INDEX = NO |
1231 | + |
1232 | +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index |
1233 | +# structure should be generated to display hierarchical information. |
1234 | +# If the tag value is set to YES, a side panel will be generated |
1235 | +# containing a tree-like index structure (just like the one that |
1236 | +# is generated for HTML Help). For this to work a browser that supports |
1237 | +# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). |
1238 | +# Windows users are probably better off using the HTML help feature. |
1239 | +# Since the tree basically has the same information as the tab index you |
1240 | +# could consider to set DISABLE_INDEX to NO when enabling this option. |
1241 | + |
1242 | +GENERATE_TREEVIEW = YES |
1243 | + |
1244 | +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values |
1245 | +# (range [0,1..20]) that doxygen will group on one line in the generated HTML |
1246 | +# documentation. Note that a value of 0 will completely suppress the enum |
1247 | +# values from appearing in the overview section. |
1248 | + |
1249 | +ENUM_VALUES_PER_LINE = 4 |
1250 | + |
1251 | +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be |
1252 | +# used to set the initial width (in pixels) of the frame in which the tree |
1253 | +# is shown. |
1254 | + |
1255 | +TREEVIEW_WIDTH = 250 |
1256 | + |
1257 | +# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open |
1258 | +# links to external symbols imported via tag files in a separate window. |
1259 | + |
1260 | +EXT_LINKS_IN_WINDOW = NO |
1261 | + |
1262 | +# Use this tag to change the font size of Latex formulas included |
1263 | +# as images in the HTML documentation. The default is 10. Note that |
1264 | +# when you change the font size after a successful doxygen run you need |
1265 | +# to manually remove any form_*.png images from the HTML output directory |
1266 | +# to force them to be regenerated. |
1267 | + |
1268 | +FORMULA_FONTSIZE = 10 |
1269 | + |
1270 | +# Use the FORMULA_TRANPARENT tag to determine whether or not the images |
1271 | +# generated for formulas are transparent PNGs. Transparent PNGs are |
1272 | +# not supported properly for IE 6.0, but are supported on all modern browsers. |
1273 | +# Note that when changing this option you need to delete any form_*.png files |
1274 | +# in the HTML output before the changes have effect. |
1275 | + |
1276 | +FORMULA_TRANSPARENT = YES |
1277 | + |
1278 | +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax |
1279 | +# (see http://www.mathjax.org) which uses client side Javascript for the |
1280 | +# rendering instead of using prerendered bitmaps. Use this if you do not |
1281 | +# have LaTeX installed or if you want to formulas look prettier in the HTML |
1282 | +# output. When enabled you may also need to install MathJax separately and |
1283 | +# configure the path to it using the MATHJAX_RELPATH option. |
1284 | + |
1285 | +USE_MATHJAX = NO |
1286 | + |
1287 | +# When MathJax is enabled you need to specify the location relative to the |
1288 | +# HTML output directory using the MATHJAX_RELPATH option. The destination |
1289 | +# directory should contain the MathJax.js script. For instance, if the mathjax |
1290 | +# directory is located at the same level as the HTML output directory, then |
1291 | +# MATHJAX_RELPATH should be ../mathjax. The default value points to |
1292 | +# the MathJax Content Delivery Network so you can quickly see the result without |
1293 | +# installing MathJax. However, it is strongly recommended to install a local |
1294 | +# copy of MathJax from http://www.mathjax.org before deployment. |
1295 | + |
1296 | +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest |
1297 | + |
1298 | +# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension |
1299 | +# names that should be enabled during MathJax rendering. |
1300 | + |
1301 | +MATHJAX_EXTENSIONS = |
1302 | + |
1303 | +# When the SEARCHENGINE tag is enabled doxygen will generate a search box |
1304 | +# for the HTML output. The underlying search engine uses javascript |
1305 | +# and DHTML and should work on any modern browser. Note that when using |
1306 | +# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets |
1307 | +# (GENERATE_DOCSET) there is already a search function so this one should |
1308 | +# typically be disabled. For large projects the javascript based search engine |
1309 | +# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. |
1310 | + |
1311 | +SEARCHENGINE = YES |
1312 | + |
1313 | +# When the SERVER_BASED_SEARCH tag is enabled the search engine will be |
1314 | +# implemented using a PHP enabled web server instead of at the web client |
1315 | +# using Javascript. Doxygen will generate the search PHP script and index |
1316 | +# file to put on the web server. The advantage of the server |
1317 | +# based approach is that it scales better to large projects and allows |
1318 | +# full text search. The disadvantages are that it is more difficult to setup |
1319 | +# and does not have live searching capabilities. |
1320 | + |
1321 | +SERVER_BASED_SEARCH = NO |
1322 | + |
1323 | +#--------------------------------------------------------------------------- |
1324 | +# configuration options related to the LaTeX output |
1325 | +#--------------------------------------------------------------------------- |
1326 | + |
1327 | +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will |
1328 | +# generate Latex output. |
1329 | + |
1330 | +GENERATE_LATEX = NO |
1331 | + |
1332 | +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. |
1333 | +# If a relative path is entered the value of OUTPUT_DIRECTORY will be |
1334 | +# put in front of it. If left blank `latex' will be used as the default path. |
1335 | + |
1336 | +LATEX_OUTPUT = latex |
1337 | + |
1338 | +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be |
1339 | +# invoked. If left blank `latex' will be used as the default command name. |
1340 | +# Note that when enabling USE_PDFLATEX this option is only used for |
1341 | +# generating bitmaps for formulas in the HTML output, but not in the |
1342 | +# Makefile that is written to the output directory. |
1343 | + |
1344 | +LATEX_CMD_NAME = latex |
1345 | + |
1346 | +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to |
1347 | +# generate index for LaTeX. If left blank `makeindex' will be used as the |
1348 | +# default command name. |
1349 | + |
1350 | +MAKEINDEX_CMD_NAME = makeindex |
1351 | + |
1352 | +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact |
1353 | +# LaTeX documents. This may be useful for small projects and may help to |
1354 | +# save some trees in general. |
1355 | + |
1356 | +COMPACT_LATEX = NO |
1357 | + |
1358 | +# The PAPER_TYPE tag can be used to set the paper type that is used |
1359 | +# by the printer. Possible values are: a4, letter, legal and |
1360 | +# executive. If left blank a4wide will be used. |
1361 | + |
1362 | +PAPER_TYPE = a4 |
1363 | + |
1364 | +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX |
1365 | +# packages that should be included in the LaTeX output. |
1366 | + |
1367 | +EXTRA_PACKAGES = |
1368 | + |
1369 | +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for |
1370 | +# the generated latex document. The header should contain everything until |
1371 | +# the first chapter. If it is left blank doxygen will generate a |
1372 | +# standard header. Notice: only use this tag if you know what you are doing! |
1373 | + |
1374 | +LATEX_HEADER = |
1375 | + |
1376 | +# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for |
1377 | +# the generated latex document. The footer should contain everything after |
1378 | +# the last chapter. If it is left blank doxygen will generate a |
1379 | +# standard footer. Notice: only use this tag if you know what you are doing! |
1380 | + |
1381 | +LATEX_FOOTER = |
1382 | + |
1383 | +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated |
1384 | +# is prepared for conversion to pdf (using ps2pdf). The pdf file will |
1385 | +# contain links (just like the HTML output) instead of page references |
1386 | +# This makes the output suitable for online browsing using a pdf viewer. |
1387 | + |
1388 | +PDF_HYPERLINKS = YES |
1389 | + |
1390 | +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of |
1391 | +# plain latex in the generated Makefile. Set this option to YES to get a |
1392 | +# higher quality PDF documentation. |
1393 | + |
1394 | +USE_PDFLATEX = YES |
1395 | + |
1396 | +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. |
1397 | +# command to the generated LaTeX files. This will instruct LaTeX to keep |
1398 | +# running if errors occur, instead of asking the user for help. |
1399 | +# This option is also used when generating formulas in HTML. |
1400 | + |
1401 | +LATEX_BATCHMODE = NO |
1402 | + |
1403 | +# If LATEX_HIDE_INDICES is set to YES then doxygen will not |
1404 | +# include the index chapters (such as File Index, Compound Index, etc.) |
1405 | +# in the output. |
1406 | + |
1407 | +LATEX_HIDE_INDICES = NO |
1408 | + |
1409 | +# If LATEX_SOURCE_CODE is set to YES then doxygen will include |
1410 | +# source code with syntax highlighting in the LaTeX output. |
1411 | +# Note that which sources are shown also depends on other settings |
1412 | +# such as SOURCE_BROWSER. |
1413 | + |
1414 | +LATEX_SOURCE_CODE = NO |
1415 | + |
1416 | +# The LATEX_BIB_STYLE tag can be used to specify the style to use for the |
1417 | +# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See |
1418 | +# http://en.wikipedia.org/wiki/BibTeX for more info. |
1419 | + |
1420 | +LATEX_BIB_STYLE = plain |
1421 | + |
1422 | +#--------------------------------------------------------------------------- |
1423 | +# configuration options related to the RTF output |
1424 | +#--------------------------------------------------------------------------- |
1425 | + |
1426 | +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output |
1427 | +# The RTF output is optimized for Word 97 and may not look very pretty with |
1428 | +# other RTF readers or editors. |
1429 | + |
1430 | +GENERATE_RTF = NO |
1431 | + |
1432 | +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. |
1433 | +# If a relative path is entered the value of OUTPUT_DIRECTORY will be |
1434 | +# put in front of it. If left blank `rtf' will be used as the default path. |
1435 | + |
1436 | +RTF_OUTPUT = rtf |
1437 | + |
1438 | +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact |
1439 | +# RTF documents. This may be useful for small projects and may help to |
1440 | +# save some trees in general. |
1441 | + |
1442 | +COMPACT_RTF = NO |
1443 | + |
1444 | +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated |
1445 | +# will contain hyperlink fields. The RTF file will |
1446 | +# contain links (just like the HTML output) instead of page references. |
1447 | +# This makes the output suitable for online browsing using WORD or other |
1448 | +# programs which support those fields. |
1449 | +# Note: wordpad (write) and others do not support links. |
1450 | + |
1451 | +RTF_HYPERLINKS = NO |
1452 | + |
1453 | +# Load style sheet definitions from file. Syntax is similar to doxygen's |
1454 | +# config file, i.e. a series of assignments. You only have to provide |
1455 | +# replacements, missing definitions are set to their default value. |
1456 | + |
1457 | +RTF_STYLESHEET_FILE = |
1458 | + |
1459 | +# Set optional variables used in the generation of an rtf document. |
1460 | +# Syntax is similar to doxygen's config file. |
1461 | + |
1462 | +RTF_EXTENSIONS_FILE = |
1463 | + |
1464 | +#--------------------------------------------------------------------------- |
1465 | +# configuration options related to the man page output |
1466 | +#--------------------------------------------------------------------------- |
1467 | + |
1468 | +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will |
1469 | +# generate man pages |
1470 | + |
1471 | +GENERATE_MAN = NO |
1472 | + |
1473 | +# The MAN_OUTPUT tag is used to specify where the man pages will be put. |
1474 | +# If a relative path is entered the value of OUTPUT_DIRECTORY will be |
1475 | +# put in front of it. If left blank `man' will be used as the default path. |
1476 | + |
1477 | +MAN_OUTPUT = man |
1478 | + |
1479 | +# The MAN_EXTENSION tag determines the extension that is added to |
1480 | +# the generated man pages (default is the subroutine's section .3) |
1481 | + |
1482 | +MAN_EXTENSION = .3 |
1483 | + |
1484 | +# If the MAN_LINKS tag is set to YES and Doxygen generates man output, |
1485 | +# then it will generate one additional man file for each entity |
1486 | +# documented in the real man page(s). These additional files |
1487 | +# only source the real man page, but without them the man command |
1488 | +# would be unable to find the correct page. The default is NO. |
1489 | + |
1490 | +MAN_LINKS = NO |
1491 | + |
1492 | +#--------------------------------------------------------------------------- |
1493 | +# configuration options related to the XML output |
1494 | +#--------------------------------------------------------------------------- |
1495 | + |
1496 | +# If the GENERATE_XML tag is set to YES Doxygen will |
1497 | +# generate an XML file that captures the structure of |
1498 | +# the code including all documentation. |
1499 | + |
1500 | +GENERATE_XML = NO |
1501 | + |
1502 | +# The XML_OUTPUT tag is used to specify where the XML pages will be put. |
1503 | +# If a relative path is entered the value of OUTPUT_DIRECTORY will be |
1504 | +# put in front of it. If left blank `xml' will be used as the default path. |
1505 | + |
1506 | +XML_OUTPUT = xml |
1507 | + |
1508 | +# The XML_SCHEMA tag can be used to specify an XML schema, |
1509 | +# which can be used by a validating XML parser to check the |
1510 | +# syntax of the XML files. |
1511 | + |
1512 | +XML_SCHEMA = |
1513 | + |
1514 | +# The XML_DTD tag can be used to specify an XML DTD, |
1515 | +# which can be used by a validating XML parser to check the |
1516 | +# syntax of the XML files. |
1517 | + |
1518 | +XML_DTD = |
1519 | + |
1520 | +# If the XML_PROGRAMLISTING tag is set to YES Doxygen will |
1521 | +# dump the program listings (including syntax highlighting |
1522 | +# and cross-referencing information) to the XML output. Note that |
1523 | +# enabling this will significantly increase the size of the XML output. |
1524 | + |
1525 | +XML_PROGRAMLISTING = YES |
1526 | + |
1527 | +#--------------------------------------------------------------------------- |
1528 | +# configuration options for the AutoGen Definitions output |
1529 | +#--------------------------------------------------------------------------- |
1530 | + |
1531 | +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will |
1532 | +# generate an AutoGen Definitions (see autogen.sf.net) file |
1533 | +# that captures the structure of the code including all |
1534 | +# documentation. Note that this feature is still experimental |
1535 | +# and incomplete at the moment. |
1536 | + |
1537 | +GENERATE_AUTOGEN_DEF = NO |
1538 | + |
1539 | +#--------------------------------------------------------------------------- |
1540 | +# configuration options related to the Perl module output |
1541 | +#--------------------------------------------------------------------------- |
1542 | + |
1543 | +# If the GENERATE_PERLMOD tag is set to YES Doxygen will |
1544 | +# generate a Perl module file that captures the structure of |
1545 | +# the code including all documentation. Note that this |
1546 | +# feature is still experimental and incomplete at the |
1547 | +# moment. |
1548 | + |
1549 | +GENERATE_PERLMOD = NO |
1550 | + |
1551 | +# If the PERLMOD_LATEX tag is set to YES Doxygen will generate |
1552 | +# the necessary Makefile rules, Perl scripts and LaTeX code to be able |
1553 | +# to generate PDF and DVI output from the Perl module output. |
1554 | + |
1555 | +PERLMOD_LATEX = NO |
1556 | + |
1557 | +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be |
1558 | +# nicely formatted so it can be parsed by a human reader. This is useful |
1559 | +# if you want to understand what is going on. On the other hand, if this |
1560 | +# tag is set to NO the size of the Perl module output will be much smaller |
1561 | +# and Perl will parse it just the same. |
1562 | + |
1563 | +PERLMOD_PRETTY = YES |
1564 | + |
1565 | +# The names of the make variables in the generated doxyrules.make file |
1566 | +# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. |
1567 | +# This is useful so different doxyrules.make files included by the same |
1568 | +# Makefile don't overwrite each other's variables. |
1569 | + |
1570 | +PERLMOD_MAKEVAR_PREFIX = |
1571 | + |
1572 | +#--------------------------------------------------------------------------- |
1573 | +# Configuration options related to the preprocessor |
1574 | +#--------------------------------------------------------------------------- |
1575 | + |
1576 | +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will |
1577 | +# evaluate all C-preprocessor directives found in the sources and include |
1578 | +# files. |
1579 | + |
1580 | +ENABLE_PREPROCESSING = YES |
1581 | + |
1582 | +# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro |
1583 | +# names in the source code. If set to NO (the default) only conditional |
1584 | +# compilation will be performed. Macro expansion can be done in a controlled |
1585 | +# way by setting EXPAND_ONLY_PREDEF to YES. |
1586 | + |
1587 | +MACRO_EXPANSION = NO |
1588 | + |
1589 | +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES |
1590 | +# then the macro expansion is limited to the macros specified with the |
1591 | +# PREDEFINED and EXPAND_AS_DEFINED tags. |
1592 | + |
1593 | +EXPAND_ONLY_PREDEF = NO |
1594 | + |
1595 | +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files |
1596 | +# pointed to by INCLUDE_PATH will be searched when a #include is found. |
1597 | + |
1598 | +SEARCH_INCLUDES = YES |
1599 | + |
1600 | +# The INCLUDE_PATH tag can be used to specify one or more directories that |
1601 | +# contain include files that are not input files but should be processed by |
1602 | +# the preprocessor. |
1603 | + |
1604 | +INCLUDE_PATH = |
1605 | + |
1606 | +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard |
1607 | +# patterns (like *.h and *.hpp) to filter out the header-files in the |
1608 | +# directories. If left blank, the patterns specified with FILE_PATTERNS will |
1609 | +# be used. |
1610 | + |
1611 | +INCLUDE_FILE_PATTERNS = |
1612 | + |
1613 | +# The PREDEFINED tag can be used to specify one or more macro names that |
1614 | +# are defined before the preprocessor is started (similar to the -D option of |
1615 | +# gcc). The argument of the tag is a list of macros of the form: name |
1616 | +# or name=definition (no spaces). If the definition and the = are |
1617 | +# omitted =1 is assumed. To prevent a macro definition from being |
1618 | +# undefined via #undef or recursively expanded use the := operator |
1619 | +# instead of the = operator. |
1620 | + |
1621 | +PREDEFINED = |
1622 | + |
1623 | +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then |
1624 | +# this tag can be used to specify a list of macro names that should be expanded. |
1625 | +# The macro definition that is found in the sources will be used. |
1626 | +# Use the PREDEFINED tag if you want to use a different macro definition that |
1627 | +# overrules the definition found in the source code. |
1628 | + |
1629 | +EXPAND_AS_DEFINED = |
1630 | + |
1631 | +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then |
1632 | +# doxygen's preprocessor will remove all references to function-like macros |
1633 | +# that are alone on a line, have an all uppercase name, and do not end with a |
1634 | +# semicolon, because these will confuse the parser if not removed. |
1635 | + |
1636 | +SKIP_FUNCTION_MACROS = YES |
1637 | + |
1638 | +#--------------------------------------------------------------------------- |
1639 | +# Configuration::additions related to external references |
1640 | +#--------------------------------------------------------------------------- |
1641 | + |
1642 | +# The TAGFILES option can be used to specify one or more tagfiles. For each |
1643 | +# tag file the location of the external documentation should be added. The |
1644 | +# format of a tag file without this location is as follows: |
1645 | +# TAGFILES = file1 file2 ... |
1646 | +# Adding location for the tag files is done as follows: |
1647 | +# TAGFILES = file1=loc1 "file2 = loc2" ... |
1648 | +# where "loc1" and "loc2" can be relative or absolute paths |
1649 | +# or URLs. Note that each tag file must have a unique name (where the name does |
1650 | +# NOT include the path). If a tag file is not located in the directory in which |
1651 | +# doxygen is run, you must also specify the path to the tagfile here. |
1652 | + |
1653 | +TAGFILES = |
1654 | + |
1655 | +# When a file name is specified after GENERATE_TAGFILE, doxygen will create |
1656 | +# a tag file that is based on the input files it reads. |
1657 | + |
1658 | +GENERATE_TAGFILE = |
1659 | + |
1660 | +# If the ALLEXTERNALS tag is set to YES all external classes will be listed |
1661 | +# in the class index. If set to NO only the inherited external classes |
1662 | +# will be listed. |
1663 | + |
1664 | +ALLEXTERNALS = NO |
1665 | + |
1666 | +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed |
1667 | +# in the modules index. If set to NO, only the current project's groups will |
1668 | +# be listed. |
1669 | + |
1670 | +EXTERNAL_GROUPS = YES |
1671 | + |
1672 | +# The PERL_PATH should be the absolute path and name of the perl script |
1673 | +# interpreter (i.e. the result of `which perl'). |
1674 | + |
1675 | +PERL_PATH = /usr/bin/perl |
1676 | + |
1677 | +#--------------------------------------------------------------------------- |
1678 | +# Configuration options related to the dot tool |
1679 | +#--------------------------------------------------------------------------- |
1680 | + |
1681 | +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will |
1682 | +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base |
1683 | +# or super classes. Setting the tag to NO turns the diagrams off. Note that |
1684 | +# this option also works with HAVE_DOT disabled, but it is recommended to |
1685 | +# install and use dot, since it yields more powerful graphs. |
1686 | + |
1687 | +CLASS_DIAGRAMS = YES |
1688 | + |
1689 | +# You can define message sequence charts within doxygen comments using the \msc |
1690 | +# command. Doxygen will then run the mscgen tool (see |
1691 | +# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the |
1692 | +# documentation. The MSCGEN_PATH tag allows you to specify the directory where |
1693 | +# the mscgen tool resides. If left empty the tool is assumed to be found in the |
1694 | +# default search path. |
1695 | + |
1696 | +DOT_PATH = @DOXYGEN_DOT_PATH@ |
1697 | + |
1698 | +# If set to YES, the inheritance and collaboration graphs will hide |
1699 | +# inheritance and usage relations if the target is undocumented |
1700 | +# or is not a class. |
1701 | + |
1702 | +HIDE_UNDOC_RELATIONS = YES |
1703 | + |
1704 | +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is |
1705 | +# available from the path. This tool is part of Graphviz, a graph visualization |
1706 | +# toolkit from AT&T and Lucent Bell Labs. The other options in this section |
1707 | +# have no effect if this option is set to NO (the default) |
1708 | + |
1709 | +HAVE_DOT = YES |
1710 | + |
1711 | +# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is |
1712 | +# allowed to run in parallel. When set to 0 (the default) doxygen will |
1713 | +# base this on the number of processors available in the system. You can set it |
1714 | +# explicitly to a value larger than 0 to get control over the balance |
1715 | +# between CPU load and processing speed. |
1716 | + |
1717 | +DOT_NUM_THREADS = 0 |
1718 | + |
1719 | +# By default doxygen will use the Helvetica font for all dot files that |
1720 | +# doxygen generates. When you want a differently looking font you can specify |
1721 | +# the font name using DOT_FONTNAME. You need to make sure dot is able to find |
1722 | +# the font, which can be done by putting it in a standard location or by setting |
1723 | +# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the |
1724 | +# directory containing the font. |
1725 | + |
1726 | +DOT_FONTNAME = Helvetica |
1727 | + |
1728 | +# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. |
1729 | +# The default size is 10pt. |
1730 | + |
1731 | +DOT_FONTSIZE = 10 |
1732 | + |
1733 | +# By default doxygen will tell dot to use the Helvetica font. |
1734 | +# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to |
1735 | +# set the path where dot can find it. |
1736 | + |
1737 | +DOT_FONTPATH = |
1738 | + |
1739 | +# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen |
1740 | +# will generate a graph for each documented class showing the direct and |
1741 | +# indirect inheritance relations. Setting this tag to YES will force the |
1742 | +# CLASS_DIAGRAMS tag to NO. |
1743 | + |
1744 | +CLASS_GRAPH = YES |
1745 | + |
1746 | +# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen |
1747 | +# will generate a graph for each documented class showing the direct and |
1748 | +# indirect implementation dependencies (inheritance, containment, and |
1749 | +# class references variables) of the class with other documented classes. |
1750 | + |
1751 | +COLLABORATION_GRAPH = YES |
1752 | + |
1753 | +# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen |
1754 | +# will generate a graph for groups, showing the direct groups dependencies |
1755 | + |
1756 | +GROUP_GRAPHS = YES |
1757 | + |
1758 | +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and |
1759 | +# collaboration diagrams in a style similar to the OMG's Unified Modeling |
1760 | +# Language. |
1761 | + |
1762 | +UML_LOOK = NO |
1763 | + |
1764 | +# If the UML_LOOK tag is enabled, the fields and methods are shown inside |
1765 | +# the class node. If there are many fields or methods and many nodes the |
1766 | +# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS |
1767 | +# threshold limits the number of items for each type to make the size more |
1768 | +# managable. Set this to 0 for no limit. Note that the threshold may be |
1769 | +# exceeded by 50% before the limit is enforced. |
1770 | + |
1771 | +UML_LIMIT_NUM_FIELDS = 10 |
1772 | + |
1773 | +# If set to YES, the inheritance and collaboration graphs will show the |
1774 | +# relations between templates and their instances. |
1775 | + |
1776 | +TEMPLATE_RELATIONS = NO |
1777 | + |
1778 | +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT |
1779 | +# tags are set to YES then doxygen will generate a graph for each documented |
1780 | +# file showing the direct and indirect include dependencies of the file with |
1781 | +# other documented files. |
1782 | + |
1783 | +INCLUDE_GRAPH = YES |
1784 | + |
1785 | +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and |
1786 | +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each |
1787 | +# documented header file showing the documented files that directly or |
1788 | +# indirectly include this file. |
1789 | + |
1790 | +INCLUDED_BY_GRAPH = YES |
1791 | + |
1792 | +# If the CALL_GRAPH and HAVE_DOT options are set to YES then |
1793 | +# doxygen will generate a call dependency graph for every global function |
1794 | +# or class method. Note that enabling this option will significantly increase |
1795 | +# the time of a run. So in most cases it will be better to enable call graphs |
1796 | +# for selected functions only using the \callgraph command. |
1797 | + |
1798 | +CALL_GRAPH = NO |
1799 | + |
1800 | +# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then |
1801 | +# doxygen will generate a caller dependency graph for every global function |
1802 | +# or class method. Note that enabling this option will significantly increase |
1803 | +# the time of a run. So in most cases it will be better to enable caller |
1804 | +# graphs for selected functions only using the \callergraph command. |
1805 | + |
1806 | +CALLER_GRAPH = NO |
1807 | + |
1808 | +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen |
1809 | +# will generate a graphical hierarchy of all classes instead of a textual one. |
1810 | + |
1811 | +GRAPHICAL_HIERARCHY = YES |
1812 | + |
1813 | +# If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES |
1814 | +# then doxygen will show the dependencies a directory has on other directories |
1815 | +# in a graphical way. The dependency relations are determined by the #include |
1816 | +# relations between the files in the directories. |
1817 | + |
1818 | +DIRECTORY_GRAPH = YES |
1819 | + |
1820 | +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images |
1821 | +# generated by dot. Possible values are svg, png, jpg, or gif. |
1822 | +# If left blank png will be used. If you choose svg you need to set |
1823 | +# HTML_FILE_EXTENSION to xhtml in order to make the SVG files |
1824 | +# visible in IE 9+ (other browsers do not have this requirement). |
1825 | + |
1826 | +DOT_IMAGE_FORMAT = png |
1827 | + |
1828 | +# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to |
1829 | +# enable generation of interactive SVG images that allow zooming and panning. |
1830 | +# Note that this requires a modern browser other than Internet Explorer. |
1831 | +# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you |
1832 | +# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files |
1833 | +# visible. Older versions of IE do not have SVG support. |
1834 | + |
1835 | +INTERACTIVE_SVG = NO |
1836 | + |
1837 | +# The tag DOT_PATH can be used to specify the path where the dot tool can be |
1838 | +# found. If left blank, it is assumed the dot tool can be found in the path. |
1839 | + |
1840 | +DOT_PATH = |
1841 | + |
1842 | +# The DOTFILE_DIRS tag can be used to specify one or more directories that |
1843 | +# contain dot files that are included in the documentation (see the |
1844 | +# \dotfile command). |
1845 | + |
1846 | +DOTFILE_DIRS = |
1847 | + |
1848 | +# The MSCFILE_DIRS tag can be used to specify one or more directories that |
1849 | +# contain msc files that are included in the documentation (see the |
1850 | +# \mscfile command). |
1851 | + |
1852 | +MSCFILE_DIRS = |
1853 | + |
1854 | +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of |
1855 | +# nodes that will be shown in the graph. If the number of nodes in a graph |
1856 | +# becomes larger than this value, doxygen will truncate the graph, which is |
1857 | +# visualized by representing a node as a red box. Note that doxygen if the |
1858 | +# number of direct children of the root node in a graph is already larger than |
1859 | +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note |
1860 | +# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. |
1861 | + |
1862 | +DOT_GRAPH_MAX_NODES = 50 |
1863 | + |
1864 | +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the |
1865 | +# graphs generated by dot. A depth value of 3 means that only nodes reachable |
1866 | +# from the root by following a path via at most 3 edges will be shown. Nodes |
1867 | +# that lay further from the root node will be omitted. Note that setting this |
1868 | +# option to 1 or 2 may greatly reduce the computation time needed for large |
1869 | +# code bases. Also note that the size of a graph can be further restricted by |
1870 | +# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. |
1871 | + |
1872 | +MAX_DOT_GRAPH_DEPTH = 0 |
1873 | + |
1874 | +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent |
1875 | +# background. This is disabled by default, because dot on Windows does not |
1876 | +# seem to support this out of the box. Warning: Depending on the platform used, |
1877 | +# enabling this option may lead to badly anti-aliased labels on the edges of |
1878 | +# a graph (i.e. they become hard to read). |
1879 | + |
1880 | +DOT_TRANSPARENT = NO |
1881 | + |
1882 | +# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output |
1883 | +# files in one run (i.e. multiple -o and -T options on the command line). This |
1884 | +# makes dot run faster, but since only newer versions of dot (>1.8.10) |
1885 | +# support this, this feature is disabled by default. |
1886 | + |
1887 | +DOT_MULTI_TARGETS = NO |
1888 | + |
1889 | +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will |
1890 | +# generate a legend page explaining the meaning of the various boxes and |
1891 | +# arrows in the dot generated graphs. |
1892 | + |
1893 | +GENERATE_LEGEND = YES |
1894 | + |
1895 | +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will |
1896 | +# remove the intermediate dot files that are used to generate |
1897 | +# the various graphs. |
1898 | + |
1899 | +DOT_CLEANUP = YES |
1900 | |
1901 | === modified file 'include/CMakeLists.txt' |
1902 | --- include/CMakeLists.txt 2013-04-05 04:27:55 +0000 |
1903 | +++ include/CMakeLists.txt 2013-04-22 12:13:31 +0000 |
1904 | @@ -18,3 +18,5 @@ |
1905 | |
1906 | set(HDR_INSTALL_DIR include) |
1907 | add_subdirectory(unity) |
1908 | + |
1909 | +set(UNITY_API_LIB_HDRS ${UNITY_API_LIB_HDRS} PARENT_SCOPE) |
1910 | |
1911 | === modified file 'include/unity/CMakeLists.txt' |
1912 | --- include/unity/CMakeLists.txt 2013-04-05 03:18:14 +0000 |
1913 | +++ include/unity/CMakeLists.txt 2013-04-22 12:13:31 +0000 |
1914 | @@ -21,5 +21,8 @@ |
1915 | add_subdirectory(util) |
1916 | |
1917 | file(GLOB headers "${CMAKE_CURRENT_SOURCE_DIR}/*.h") |
1918 | +file(GLOB internal_headers "${CMAKE_CURRENT_SOURCE_DIR}/internal/*.h") |
1919 | |
1920 | install(FILES ${headers} DESTINATION ${HDR_INSTALL_DIR}/unity) |
1921 | + |
1922 | +set(UNITY_API_LIB_HDRS ${UNITY_API_LIB_HDRS} ${headers} ${internal_headers} PARENT_SCOPE) |
1923 | |
1924 | === modified file 'include/unity/api/CMakeLists.txt' |
1925 | --- include/unity/api/CMakeLists.txt 2013-04-05 11:03:11 +0000 |
1926 | +++ include/unity/api/CMakeLists.txt 2013-04-22 12:13:31 +0000 |
1927 | @@ -17,6 +17,7 @@ |
1928 | # |
1929 | |
1930 | file(GLOB headers "${CMAKE_CURRENT_SOURCE_DIR}/*.h") |
1931 | +file(GLOB internal_headers "${CMAKE_CURRENT_SOURCE_DIR}/internal/*.h") |
1932 | |
1933 | # |
1934 | # Generated headers |
1935 | @@ -25,3 +26,5 @@ |
1936 | set(headers ${headers} ${CMAKE_CURRENT_BINARY_DIR}/Version.h) |
1937 | |
1938 | install(FILES ${headers} DESTINATION ${HDR_INSTALL_DIR}/unity/api) |
1939 | + |
1940 | +set(UNITY_API_LIB_HDRS ${UNITY_API_LIB_HDRS} ${headers} ${internal_headers} PARENT_SCOPE) |
1941 | |
1942 | === modified file 'include/unity/scopes/CMakeLists.txt' |
1943 | --- include/unity/scopes/CMakeLists.txt 2013-04-04 02:16:16 +0000 |
1944 | +++ include/unity/scopes/CMakeLists.txt 2013-04-22 12:13:31 +0000 |
1945 | @@ -17,5 +17,8 @@ |
1946 | # |
1947 | |
1948 | file(GLOB headers "${CMAKE_CURRENT_SOURCE_DIR}/*.h") |
1949 | +file(GLOB internal_headers "${CMAKE_CURRENT_SOURCE_DIR}/internal/*.h") |
1950 | |
1951 | install(FILES ${headers} DESTINATION include/unity/scopes) |
1952 | + |
1953 | +set(UNITY_API_LIB_HDRS ${UNITY_API_LIB_HDRS} ${headers} ${internal_headers} PARENT_SCOPE) |
1954 | |
1955 | === modified file 'include/unity/util/CMakeLists.txt' |
1956 | --- include/unity/util/CMakeLists.txt 2013-04-05 03:18:14 +0000 |
1957 | +++ include/unity/util/CMakeLists.txt 2013-04-22 12:13:31 +0000 |
1958 | @@ -17,5 +17,8 @@ |
1959 | # |
1960 | |
1961 | file(GLOB headers "${CMAKE_CURRENT_SOURCE_DIR}/*.h") |
1962 | +file(GLOB internal_headers "${CMAKE_CURRENT_SOURCE_DIR}/internal/*.h") |
1963 | |
1964 | install(FILES ${headers} DESTINATION ${HDR_INSTALL_DIR}/unity/util) |
1965 | + |
1966 | +set(UNITY_API_LIB_HDRS ${UNITY_API_LIB_HDRS} ${headers} ${internal_headers} PARENT_SCOPE) |
1967 | |
1968 | === modified file 'src/CMakeLists.txt' |
1969 | --- src/CMakeLists.txt 2013-04-10 11:42:03 +0000 |
1970 | +++ src/CMakeLists.txt 2013-04-22 12:13:31 +0000 |
1971 | @@ -28,3 +28,5 @@ |
1972 | |
1973 | configure_file(lib${UNITY_API_LIB}.pc.in lib${UNITY_API_LIB}.pc @ONLY) |
1974 | install(FILES ${CMAKE_CURRENT_BINARY_DIR}/lib${UNITY_API_LIB}.pc DESTINATION lib/pkgconfig) |
1975 | + |
1976 | +set(UNITY_API_LIB_SRC ${UNITY_API_LIB_SRC} ${UNITY_SRC} PARENT_SCOPE) |
1977 | |
1978 | === modified file 'src/unity/api/scopes/internal/CMakeLists.txt' |
1979 | --- src/unity/api/scopes/internal/CMakeLists.txt 2013-04-04 02:16:16 +0000 |
1980 | +++ src/unity/api/scopes/internal/CMakeLists.txt 2013-04-22 12:13:31 +0000 |
1981 | @@ -19,4 +19,4 @@ |
1982 | set(SCOPES_INTERNAL_SRC |
1983 | ) |
1984 | |
1985 | -set(UNITY_API_LIB_SRC ${UNITY_API_LIB_SRC} ${UNITY_SCOPES_INTERNAL_SRC} PARENT_SCOPE) |
1986 | +set(UNITY_API_LIB_SRC ${UNITY_API_LIB_SRC} ${SCOPES_INTERNAL_SRC} PARENT_SCOPE) |
FAILED: Continuous integration, rev:603 jenkins. qa.ubuntu. com/job/ unity-phablet- ci/573/ s-jenkins: 8080/job/ unity-phablet- qmluitests/ 368/console jenkins. qa.ubuntu. com/job/ unity-phablet- quantal- armhf-ci/ 574/console jenkins. qa.ubuntu. com/job/ unity-phablet- quantal- i386-ci/ 573/console jenkins. qa.ubuntu. com/job/ unity-phablet- raring- armhf-ci/ 449/console jenkins. qa.ubuntu. com/job/ unity-phablet- raring- i386-ci/ 453/console
http://
Executed test runs:
FAILURE: http://
FAILURE: http://
FAILURE: http://
FAILURE: http://
FAILURE: http://
Click here to trigger a rebuild: s-jenkins: 8080/job/ unity-phablet- ci/573/ rebuild
http://