Browse code

Supporting files for doxygen

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