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 @@
1
+/**
2
+ * \mainpage SER Development Documentation
3
+ *
4
+ * The development documentation for SER consists of annotated and documented
5
+ * source files. For the sake of clarity the documentation is split into the
6
+ * following groups:
7
+ *
8
+ * \section db_layer Database Abstraction Layer
9
+ *
10
+ * \ref db_api Database Abstraction Layer is a group of data structures and functions that
11
+ * are used by all SER modules that need to access a database.
12
+ *
13
+ * \section ser_modules SER Modules
14
+ */
0 15
new file mode 100644
... ...
@@ -0,0 +1,262 @@
1
+# Doxyfile 1.5.1
2
+
3
+#---------------------------------------------------------------------------
4
+# Project related configuration options
5
+#---------------------------------------------------------------------------
6
+PROJECT_NAME           = SER
7
+PROJECT_NUMBER         = 2.0
8
+OUTPUT_DIRECTORY       = doc/doxygen/output
9
+CREATE_SUBDIRS         = YES
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        = NO
28
+STRIP_FROM_PATH        = 
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  = YES
39
+OPTIMIZE_OUTPUT_JAVA   = NO
40
+BUILTIN_STL_SUPPORT    = NO
41
+DISTRIBUTE_GROUP_DOC   = NO
42
+SUBGROUPING            = YES
43
+#---------------------------------------------------------------------------
44
+# Build related configuration options
45
+#---------------------------------------------------------------------------
46
+EXTRACT_ALL            = NO
47
+EXTRACT_PRIVATE        = NO
48
+EXTRACT_STATIC         = NO
49
+EXTRACT_LOCAL_CLASSES  = YES
50
+EXTRACT_LOCAL_METHODS  = NO
51
+HIDE_UNDOC_MEMBERS     = YES
52
+HIDE_UNDOC_CLASSES     = YES
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    = "/bin/sh doc/doxygen/versionfilter.sh"
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                  = 
86
+FILE_PATTERNS          = *.c \
87
+                         *.cc \
88
+                         *.cxx \
89
+                         *.cpp \
90
+                         *.c++ \
91
+                         *.h \
92
+                         *.hh \
93
+                         *.hxx \
94
+                         *.hpp \
95
+                         *.h++ \
96
+                         *.php \
97
+                         *.php3 \
98
+                         *.dox \
99
+                         *.py \
100
+                         *.C \
101
+                         *.CC \
102
+                         *.C++ \
103
+                         *.H \
104
+                         *.HH \
105
+                         *.H++ \
106
+                         *.PHP \
107
+                         *.PHP3 \
108
+                         *.PY
109
+RECURSIVE              = YES
110
+EXCLUDE                =
111
+EXCLUDE_SYMLINKS       = NO
112
+EXCLUDE_PATTERNS       = */CVS/* \
113
+			 */etc/* \
114
+			 */examples/* \
115
+			 */pkg/* \
116
+			 */profile/* \
117
+			 */scripts/*
118
+EXAMPLE_PATH           = doc/doxygen/examples
119
+EXAMPLE_PATTERNS       = *
120
+EXAMPLE_RECURSIVE      = NO
121
+IMAGE_PATH             = 
122
+INPUT_FILTER           = 
123
+FILTER_PATTERNS        = 
124
+FILTER_SOURCE_FILES    = NO
125
+#---------------------------------------------------------------------------
126
+# configuration options related to source browsing
127
+#---------------------------------------------------------------------------
128
+SOURCE_BROWSER         = YES
129
+INLINE_SOURCES         = NO
130
+STRIP_CODE_COMMENTS    = YES
131
+REFERENCED_BY_RELATION = YES
132
+REFERENCES_RELATION    = YES
133
+REFERENCES_LINK_SOURCE = YES
134
+USE_HTAGS              = NO
135
+VERBATIM_HEADERS       = YES
136
+#---------------------------------------------------------------------------
137
+# configuration options related to the alphabetical class index
138
+#---------------------------------------------------------------------------
139
+ALPHABETICAL_INDEX     = NO
140
+COLS_IN_ALPHA_INDEX    = 5
141
+IGNORE_PREFIX          = 
142
+#---------------------------------------------------------------------------
143
+# configuration options related to the HTML output
144
+#---------------------------------------------------------------------------
145
+GENERATE_HTML          = YES
146
+HTML_OUTPUT            = html
147
+HTML_FILE_EXTENSION    = .html
148
+HTML_HEADER            = 
149
+HTML_FOOTER            = 
150
+HTML_STYLESHEET        = 
151
+HTML_ALIGN_MEMBERS     = YES
152
+GENERATE_HTMLHELP      = NO
153
+CHM_FILE               = 
154
+HHC_LOCATION           = 
155
+GENERATE_CHI           = NO
156
+BINARY_TOC             = NO
157
+TOC_EXPAND             = YES
158
+DISABLE_INDEX          = NO
159
+ENUM_VALUES_PER_LINE   = 4
160
+GENERATE_TREEVIEW      = no
161
+TREEVIEW_WIDTH         = 250
162
+#---------------------------------------------------------------------------
163
+# configuration options related to the LaTeX output
164
+#---------------------------------------------------------------------------
165
+GENERATE_LATEX         = NO
166
+LATEX_OUTPUT           = latex
167
+LATEX_CMD_NAME         = latex
168
+MAKEINDEX_CMD_NAME     = makeindex
169
+COMPACT_LATEX          = NO
170
+PAPER_TYPE             = a4wide
171
+EXTRA_PACKAGES         = 
172
+LATEX_HEADER           = 
173
+PDF_HYPERLINKS         = NO
174
+USE_PDFLATEX           = NO
175
+LATEX_BATCHMODE        = NO
176
+LATEX_HIDE_INDICES     = NO
177
+#---------------------------------------------------------------------------
178
+# configuration options related to the RTF output
179
+#---------------------------------------------------------------------------
180
+GENERATE_RTF           = NO
181
+RTF_OUTPUT             = rtf
182
+COMPACT_RTF            = NO
183
+RTF_HYPERLINKS         = NO
184
+RTF_STYLESHEET_FILE    = 
185
+RTF_EXTENSIONS_FILE    = 
186
+#---------------------------------------------------------------------------
187
+# configuration options related to the man page output
188
+#---------------------------------------------------------------------------
189
+GENERATE_MAN           = NO
190
+MAN_OUTPUT             = man
191
+MAN_EXTENSION          = .3
192
+MAN_LINKS              = NO
193
+#---------------------------------------------------------------------------
194
+# configuration options related to the XML output
195
+#---------------------------------------------------------------------------
196
+GENERATE_XML           = NO
197
+XML_OUTPUT             = xml
198
+XML_SCHEMA             = 
199
+XML_DTD                = 
200
+XML_PROGRAMLISTING     = YES
201
+#---------------------------------------------------------------------------
202
+# configuration options for the AutoGen Definitions output
203
+#---------------------------------------------------------------------------
204
+GENERATE_AUTOGEN_DEF   = NO
205
+#---------------------------------------------------------------------------
206
+# configuration options related to the Perl module output
207
+#---------------------------------------------------------------------------
208
+GENERATE_PERLMOD       = NO
209
+PERLMOD_LATEX          = NO
210
+PERLMOD_PRETTY         = YES
211
+PERLMOD_MAKEVAR_PREFIX = 
212
+#---------------------------------------------------------------------------
213
+# Configuration options related to the preprocessor   
214
+#---------------------------------------------------------------------------
215
+ENABLE_PREPROCESSING   = YES
216
+MACRO_EXPANSION        = NO
217
+EXPAND_ONLY_PREDEF     = NO
218
+SEARCH_INCLUDES        = YES
219
+INCLUDE_PATH           = 
220
+INCLUDE_FILE_PATTERNS  = 
221
+PREDEFINED             = 
222
+EXPAND_AS_DEFINED      = 
223
+SKIP_FUNCTION_MACROS   = YES
224
+#---------------------------------------------------------------------------
225
+# Configuration::additions related to external references   
226
+#---------------------------------------------------------------------------
227
+TAGFILES               = 
228
+GENERATE_TAGFILE       = 
229
+ALLEXTERNALS           = NO
230
+EXTERNAL_GROUPS        = YES
231
+PERL_PATH              = /usr/bin/perl
232
+#---------------------------------------------------------------------------
233
+# Configuration options related to the dot tool   
234
+#---------------------------------------------------------------------------
235
+CLASS_DIAGRAMS         = NO
236
+HIDE_UNDOC_RELATIONS   = YES
237
+HAVE_DOT               = YES
238
+CLASS_GRAPH            = YES
239
+COLLABORATION_GRAPH    = YES
240
+GROUP_GRAPHS           = YES
241
+UML_LOOK               = NO
242
+TEMPLATE_RELATIONS     = NO
243
+INCLUDE_GRAPH          = YES
244
+INCLUDED_BY_GRAPH      = YES
245
+CALL_GRAPH             = NO
246
+CALLER_GRAPH           = NO
247
+GRAPHICAL_HIERARCHY    = YES
248
+DIRECTORY_GRAPH        = YES
249
+DOT_IMAGE_FORMAT       = png
250
+DOT_PATH               = 
251
+DOTFILE_DIRS           = 
252
+MAX_DOT_GRAPH_WIDTH    = 1024
253
+MAX_DOT_GRAPH_HEIGHT   = 1024
254
+MAX_DOT_GRAPH_DEPTH    = 1000
255
+DOT_TRANSPARENT        = NO
256
+DOT_MULTI_TARGETS      = NO
257
+GENERATE_LEGEND        = YES
258
+DOT_CLEANUP            = YES
259
+#---------------------------------------------------------------------------
260
+# Configuration::additions related to the search engine   
261
+#---------------------------------------------------------------------------
262
+SEARCHENGINE           = NO
0 263
new file mode 100755
... ...
@@ -0,0 +1,4 @@
1
+#!/bin/sh
2
+echo $1
3
+cvs status $1 | sed -n 's/^[ \]*Working revision:[ \t]*\([0-9][0-9\.]*\).*/\1/p'
4
+