Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/Doxyfile @ 3188

Last change on this file since 3188 was 2873, checked in by bknecht, 16 years ago

Doxygen fixes. Please advise me on better places or methods to fix it.

At the moment the Orxonox Doxygen Documentation is called "Bullet Documentation" due to Doxygen code inside the included Bullet files. I commented out this main-page of the documentation as it will most probably solve the problem.
Further I changed the version to 0.0.2 Bellatrix as this is the current version we're working on as far as I know.

Oh yeah, I added a doxygen mainpage comment at the beginning of Main.cc maybe there's a better place for this.

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