1 #--------------------------------------------------------------------------- |
1 #--------------------------------------------------------------------------- |
2 # |
2 # |
3 # Doxyfile 1.4.4 |
3 # Doxyfile 1.4.4 |
4 # |
4 # |
5 # IgH EtherCAT-Treiber |
5 # IgH EtherCAT driver |
6 # |
6 # |
7 # $Id$ |
7 # $Id$ |
8 # |
8 # |
9 #--------------------------------------------------------------------------- |
9 #--------------------------------------------------------------------------- |
10 |
10 |
11 # This file describes the settings to be used by the documentation system |
11 # This file describes the settings to be used by the documentation system |
12 # doxygen (www.doxygen.org) for a project |
12 # doxygen (www.doxygen.org) for a project |
23 #--------------------------------------------------------------------------- |
23 #--------------------------------------------------------------------------- |
24 |
24 |
25 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded |
25 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded |
26 # by quotes) that should identify the project. |
26 # by quotes) that should identify the project. |
27 |
27 |
28 PROJECT_NAME = EtherCAT |
28 PROJECT_NAME = "IgH EtherCAT master" |
29 |
29 |
30 # The PROJECT_NUMBER tag can be used to enter a project or revision number. |
30 # The PROJECT_NUMBER tag can be used to enter a project or revision number. |
31 # This could be handy for archiving the generated documentation or |
31 # This could be handy for archiving the generated documentation or |
32 # if some version control system is used. |
32 # if some version control system is used. |
33 |
33 |
36 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) |
36 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) |
37 # base path where the generated documentation will be put. |
37 # base path where the generated documentation will be put. |
38 # If a relative path is entered, it will be relative to the location |
38 # If a relative path is entered, it will be relative to the location |
39 # where doxygen was started. If left blank the current directory will be used. |
39 # where doxygen was started. If left blank the current directory will be used. |
40 |
40 |
41 OUTPUT_DIRECTORY = doc |
41 OUTPUT_DIRECTORY = documentation/doxygen-output |
42 |
42 |
43 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create |
43 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create |
44 # 4096 sub-directories (in 2 levels) under the output directory of each output |
44 # 4096 sub-directories (in 2 levels) under the output directory of each output |
45 # format and will distribute the generated files over these directories. |
45 # format and will distribute the generated files over these directories. |
46 # Enabling this option can be useful when feeding doxygen a huge amount of |
46 # Enabling this option can be useful when feeding doxygen a huge amount of |
57 # Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese, |
57 # Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese, |
58 # Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian, |
58 # Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian, |
59 # Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, |
59 # Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, |
60 # Swedish, and Ukrainian. |
60 # Swedish, and Ukrainian. |
61 |
61 |
62 OUTPUT_LANGUAGE = German |
62 OUTPUT_LANGUAGE = English |
63 |
63 |
64 # This tag can be used to specify the encoding used in the generated output. |
64 # This tag can be used to specify the encoding used in the generated output. |
65 # The encoding is not always determined by the language that is chosen, |
65 # The encoding is not always determined by the language that is chosen, |
66 # but also whether or not the output is meant for Windows or non-Windows users. |
66 # but also whether or not the output is meant for Windows or non-Windows users. |
67 # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES |
67 # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES |
183 SEPARATE_MEMBER_PAGES = NO |
183 SEPARATE_MEMBER_PAGES = NO |
184 |
184 |
185 # The TAB_SIZE tag can be used to set the number of spaces in a tab. |
185 # The TAB_SIZE tag can be used to set the number of spaces in a tab. |
186 # Doxygen uses this value to replace tabs by spaces in code fragments. |
186 # Doxygen uses this value to replace tabs by spaces in code fragments. |
187 |
187 |
188 TAB_SIZE = 3 |
188 TAB_SIZE = 4 |
189 |
189 |
190 # This tag can be used to specify a number of aliases that acts |
190 # This tag can be used to specify a number of aliases that acts |
191 # as commands in the documentation. An alias has the form "name=value". |
191 # as commands in the documentation. An alias has the form "name=value". |
192 # For example adding "sideeffect=\par Side Effects:\n" will allow you to |
192 # For example adding "sideeffect=\par Side Effects:\n" will allow you to |
193 # put the command \sideeffect (or @sideeffect) in the documentation, which |
193 # put the command \sideeffect (or @sideeffect) in the documentation, which |
225 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in |
225 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in |
226 # documentation are documented, even if no documentation was available. |
226 # documentation are documented, even if no documentation was available. |
227 # Private class members and static file members will be hidden unless |
227 # Private class members and static file members will be hidden unless |
228 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES |
228 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES |
229 |
229 |
230 EXTRACT_ALL = YES |
230 EXTRACT_ALL = NO |
231 |
231 |
232 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class |
232 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class |
233 # will be included in the documentation. |
233 # will be included in the documentation. |
234 |
234 |
235 EXTRACT_PRIVATE = YES |
235 EXTRACT_PRIVATE = YES |
256 # undocumented members of documented classes, files or namespaces. |
256 # undocumented members of documented classes, files or namespaces. |
257 # If set to NO (the default) these members will be included in the |
257 # If set to NO (the default) these members will be included in the |
258 # various overviews, but no documentation section is generated. |
258 # various overviews, but no documentation section is generated. |
259 # This option has no effect if EXTRACT_ALL is enabled. |
259 # This option has no effect if EXTRACT_ALL is enabled. |
260 |
260 |
261 HIDE_UNDOC_MEMBERS = YES |
261 HIDE_UNDOC_MEMBERS = NO |
262 |
262 |
263 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all |
263 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all |
264 # undocumented classes that are normally visible in the class hierarchy. |
264 # undocumented classes that are normally visible in the class hierarchy. |
265 # If set to NO (the default) these classes will be included in the various |
265 # If set to NO (the default) these classes will be included in the various |
266 # overviews. This option has no effect if EXTRACT_ALL is enabled. |
266 # overviews. This option has no effect if EXTRACT_ALL is enabled. |
267 |
267 |
268 HIDE_UNDOC_CLASSES = YES |
268 HIDE_UNDOC_CLASSES = NO |
269 |
269 |
270 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all |
270 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all |
271 # friend (class|struct|union) declarations. |
271 # friend (class|struct|union) declarations. |
272 # If set to NO (the default) these declarations will be included in the |
272 # If set to NO (the default) these declarations will be included in the |
273 # documentation. |
273 # documentation. |
430 # functions that are documented, but have no documentation for their parameters |
430 # functions that are documented, but have no documentation for their parameters |
431 # or return value. If set to NO (the default) doxygen will only warn about |
431 # or return value. If set to NO (the default) doxygen will only warn about |
432 # wrong or incomplete parameter documentation, but not about the absence of |
432 # wrong or incomplete parameter documentation, but not about the absence of |
433 # documentation. |
433 # documentation. |
434 |
434 |
435 WARN_NO_PARAMDOC = NO |
435 WARN_NO_PARAMDOC = YES |
436 |
436 |
437 # The WARN_FORMAT tag determines the format of the warning messages that |
437 # The WARN_FORMAT tag determines the format of the warning messages that |
438 # doxygen can produce. The string should contain the $file, $line, and $text |
438 # doxygen can produce. The string should contain the $file, $line, and $text |
439 # tags, which will be replaced by the file and line number from which the |
439 # tags, which will be replaced by the file and line number from which the |
440 # warning originated and the warning text. Optionally the format may contain |
440 # warning originated and the warning text. Optionally the format may contain |