root/trunk/doxygen/Doxyfile

Revision 3925, 9.9 kB (checked in by tarjei, 2 years ago)

The start of a doxygen documentation

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