RPA Toolkit
documentaion changes
[rpatk.git] / doc / doxygen / rpa.cfg
1 # Doxyfile 1.7.4-20110426
2
3 #---------------------------------------------------------------------------
4 # Project related configuration options
5 #---------------------------------------------------------------------------
6 DOXYFILE_ENCODING      = UTF-8
7 PROJECT_NAME           =
8 PROJECT_NUMBER         =
9 PROJECT_BRIEF          =
10 PROJECT_LOGO           =
11 OUTPUT_DIRECTORY       = rpadoc
12 CREATE_SUBDIRS         = NO
13 OUTPUT_LANGUAGE        = English
14 BRIEF_MEMBER_DESC      = YES
15 REPEAT_BRIEF           = YES
16 ABBREVIATE_BRIEF       =
17 ALWAYS_DETAILED_SEC    = NO
18 INLINE_INHERITED_MEMB  = NO
19 FULL_PATH_NAMES        = NO
20 STRIP_FROM_PATH        =
21 STRIP_FROM_INC_PATH    =
22 SHORT_NAMES            = NO
23 JAVADOC_AUTOBRIEF      = NO
24 QT_AUTOBRIEF           = NO
25 MULTILINE_CPP_IS_BRIEF = NO
26 INHERIT_DOCS           = YES
27 SEPARATE_MEMBER_PAGES  = NO
28 TAB_SIZE               = 8
29 ALIASES                =
30 OPTIMIZE_OUTPUT_FOR_C  = NO
31 OPTIMIZE_OUTPUT_JAVA   = NO
32 OPTIMIZE_FOR_FORTRAN   = NO
33 OPTIMIZE_OUTPUT_VHDL   = NO
34 EXTENSION_MAPPING      =
35 BUILTIN_STL_SUPPORT    = NO
36 CPP_CLI_SUPPORT        = NO
37 SIP_SUPPORT            = NO
38 IDL_PROPERTY_SUPPORT   = YES
39 DISTRIBUTE_GROUP_DOC   = NO
40 SUBGROUPING            = YES
41 INLINE_GROUPED_CLASSES = NO
42 TYPEDEF_HIDES_STRUCT   = NO
43 SYMBOL_CACHE_SIZE      = 0
44 #---------------------------------------------------------------------------
45 # Build related configuration options
46 #---------------------------------------------------------------------------
47 EXTRACT_ALL            = NO
48 EXTRACT_PRIVATE        = NO
49 EXTRACT_STATIC         = NO
50 EXTRACT_LOCAL_CLASSES  = YES
51 EXTRACT_LOCAL_METHODS  = NO
52 EXTRACT_ANON_NSPACES   = NO
53 HIDE_UNDOC_MEMBERS     = YES
54 HIDE_UNDOC_CLASSES     = YES
55 HIDE_FRIEND_COMPOUNDS  = NO
56 HIDE_IN_BODY_DOCS      = YES
57 INTERNAL_DOCS          = NO
58 CASE_SENSE_NAMES       = YES
59 HIDE_SCOPE_NAMES       = NO
60 SHOW_INCLUDE_FILES     = NO
61 FORCE_LOCAL_INCLUDES   = NO
62 INLINE_INFO            = YES
63 SORT_MEMBER_DOCS       = YES
64 SORT_BRIEF_DOCS        = NO
65 SORT_MEMBERS_CTORS_1ST = NO
66 SORT_GROUP_NAMES       = NO
67 SORT_BY_SCOPE_NAME     = NO
68 STRICT_PROTO_MATCHING  = NO
69 GENERATE_TODOLIST      = YES
70 GENERATE_TESTLIST      = YES
71 GENERATE_BUGLIST       = YES
72 GENERATE_DEPRECATEDLIST= YES
73 ENABLED_SECTIONS       =
74 MAX_INITIALIZER_LINES  = 30
75 SHOW_USED_FILES        = YES
76 SHOW_DIRECTORIES       = NO
77 SHOW_FILES             = YES
78 SHOW_NAMESPACES        = YES
79 FILE_VERSION_FILTER    =
80 LAYOUT_FILE            =
81 #---------------------------------------------------------------------------
82 # configuration options related to warning and progress messages
83 #---------------------------------------------------------------------------
84 QUIET                  = NO
85 WARNINGS               = YES
86 WARN_IF_UNDOCUMENTED   = YES
87 WARN_IF_DOC_ERROR      = YES
88 WARN_NO_PARAMDOC       = NO
89 WARN_FORMAT            = "$file:$line: $text"
90 WARN_LOGFILE           =
91 #---------------------------------------------------------------------------
92 # configuration options related to the input files
93 #---------------------------------------------------------------------------
94 INPUT                  = ../../rpa/rpadbex.h \
95                          ../../rpa/rpastat.h \
96                          ../../rpa/rparecord.h \
97                          ../../rpa/rpaerror.h \
98                          ../../rpa/doc/main.txt \
99                          ../../rpa/doc/rpatk_build.txt \
100                          ../../rpa/doc/rpa_main.txt \
101                          ../../rpa/doc/rpa_intro.txt \
102                          ../../rpa/doc/rpa_bnf.txt \
103                          ../../rpa/doc/rpa_dbex.txt \
104                          ../../rpa/doc/rpa_stat.txt \
105                          ../../rpa/doc/rpa_record.txt \
106                          ../../rpa/doc/introduction.txt 
107
108 INPUT_ENCODING         = UTF-8
109 FILE_PATTERNS          =
110 RECURSIVE              = NO
111 EXCLUDE                =
112 EXCLUDE_SYMLINKS       = NO
113 EXCLUDE_PATTERNS       =
114 EXCLUDE_SYMBOLS        =
115 EXAMPLE_PATH           = ../../rpa/doc/example
116 EXAMPLE_PATTERNS       =
117 EXAMPLE_RECURSIVE      = NO
118 IMAGE_PATH             =
119 INPUT_FILTER           =
120 FILTER_PATTERNS        =
121 FILTER_SOURCE_FILES    = NO
122 FILTER_SOURCE_PATTERNS =
123 #---------------------------------------------------------------------------
124 # configuration options related to source browsing
125 #---------------------------------------------------------------------------
126 SOURCE_BROWSER         = NO
127 INLINE_SOURCES         = NO
128 STRIP_CODE_COMMENTS    = YES
129 REFERENCED_BY_RELATION = NO
130 REFERENCES_RELATION    = NO
131 REFERENCES_LINK_SOURCE = YES
132 USE_HTAGS              = NO
133 VERBATIM_HEADERS       = YES
134 #---------------------------------------------------------------------------
135 # configuration options related to the alphabetical class index
136 #---------------------------------------------------------------------------
137 ALPHABETICAL_INDEX     = YES
138 COLS_IN_ALPHA_INDEX    = 5
139 IGNORE_PREFIX          =
140 #---------------------------------------------------------------------------
141 # configuration options related to the HTML output
142 #---------------------------------------------------------------------------
143 GENERATE_HTML          = YES
144 HTML_OUTPUT            = html
145 HTML_FILE_EXTENSION    = .html
146 HTML_HEADER            = header.html
147 HTML_FOOTER            = footer.html
148 HTML_STYLESHEET        = customdoxygen.css
149 HTML_EXTRA_FILES       = artwork/logoRPA.png artwork/bannerleft.png artwork/bannerright.png artwork/logoR.png style.css
150 HTML_COLORSTYLE_HUE    = 220
151 HTML_COLORSTYLE_SAT    = 100
152 HTML_COLORSTYLE_GAMMA  = 80
153 HTML_TIMESTAMP         = YES
154 HTML_ALIGN_MEMBERS     = YES
155 HTML_DYNAMIC_SECTIONS  = NO
156 GENERATE_DOCSET        = NO
157 DOCSET_FEEDNAME        = "Doxygen generated docs"
158 DOCSET_BUNDLE_ID       = org.doxygen.Project
159 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
160 DOCSET_PUBLISHER_NAME  = Publisher
161 GENERATE_HTMLHELP      = YES
162 CHM_FILE               =
163 HHC_LOCATION           =
164 GENERATE_CHI           = NO
165 CHM_INDEX_ENCODING     =
166 BINARY_TOC             = NO
167 TOC_EXPAND             = YES
168 GENERATE_QHP           = NO
169 QCH_FILE               =
170 QHP_NAMESPACE          = org.doxygen.Project
171 QHP_VIRTUAL_FOLDER     = doc
172 QHP_CUST_FILTER_NAME   =
173 QHP_CUST_FILTER_ATTRS  =
174 QHP_SECT_FILTER_ATTRS  =
175 QHG_LOCATION           =
176 GENERATE_ECLIPSEHELP   = NO
177 ECLIPSE_DOC_ID         = org.doxygen.Project
178 DISABLE_INDEX          = NO
179 ENUM_VALUES_PER_LINE   = 4
180 GENERATE_TREEVIEW      = NO
181 USE_INLINE_TREES       = NO
182 TREEVIEW_WIDTH         = 250
183 EXT_LINKS_IN_WINDOW    = NO
184 FORMULA_FONTSIZE       = 10
185 FORMULA_TRANSPARENT    = YES
186 USE_MATHJAX            = NO
187 MATHJAX_RELPATH        = http://www.mathjax.org/mathjax
188 SEARCHENGINE           = YES
189 SERVER_BASED_SEARCH    = NO
190 #---------------------------------------------------------------------------
191 # configuration options related to the LaTeX output
192 #---------------------------------------------------------------------------
193 GENERATE_LATEX         = NO
194 LATEX_OUTPUT           = latex
195 LATEX_CMD_NAME         = latex
196 MAKEINDEX_CMD_NAME     = makeindex
197 COMPACT_LATEX          = NO
198 PAPER_TYPE             = a4
199 EXTRA_PACKAGES         =
200 LATEX_HEADER           =
201 LATEX_FOOTER           =
202 PDF_HYPERLINKS         = YES
203 USE_PDFLATEX           = YES
204 LATEX_BATCHMODE        = NO
205 LATEX_HIDE_INDICES     = NO
206 LATEX_SOURCE_CODE      = NO
207 #---------------------------------------------------------------------------
208 # configuration options related to the RTF output
209 #---------------------------------------------------------------------------
210 GENERATE_RTF           = NO
211 RTF_OUTPUT             = rtf
212 COMPACT_RTF            = NO
213 RTF_HYPERLINKS         = NO
214 RTF_STYLESHEET_FILE    =
215 RTF_EXTENSIONS_FILE    =
216 #---------------------------------------------------------------------------
217 # configuration options related to the man page output
218 #---------------------------------------------------------------------------
219 GENERATE_MAN           = NO
220 MAN_OUTPUT             = man
221 MAN_EXTENSION          = .3
222 MAN_LINKS              = NO
223 #---------------------------------------------------------------------------
224 # configuration options related to the XML output
225 #---------------------------------------------------------------------------
226 GENERATE_XML           = NO
227 XML_OUTPUT             = xml
228 XML_SCHEMA             =
229 XML_DTD                =
230 XML_PROGRAMLISTING     = YES
231 #---------------------------------------------------------------------------
232 # configuration options for the AutoGen Definitions output
233 #---------------------------------------------------------------------------
234 GENERATE_AUTOGEN_DEF   = NO
235 #---------------------------------------------------------------------------
236 # configuration options related to the Perl module output
237 #---------------------------------------------------------------------------
238 GENERATE_PERLMOD       = NO
239 PERLMOD_LATEX          = NO
240 PERLMOD_PRETTY         = YES
241 PERLMOD_MAKEVAR_PREFIX =
242 #---------------------------------------------------------------------------
243 # Configuration options related to the preprocessor
244 #---------------------------------------------------------------------------
245 ENABLE_PREPROCESSING   = YES
246 MACRO_EXPANSION        = NO
247 EXPAND_ONLY_PREDEF     = NO
248 SEARCH_INCLUDES        = YES
249 INCLUDE_PATH           =
250 INCLUDE_FILE_PATTERNS  =
251 PREDEFINED             =
252 EXPAND_AS_DEFINED      =
253 SKIP_FUNCTION_MACROS   = YES
254 #---------------------------------------------------------------------------
255 # Configuration::additions related to external references
256 #---------------------------------------------------------------------------
257 TAGFILES               =
258 GENERATE_TAGFILE       =
259 ALLEXTERNALS           = NO
260 EXTERNAL_GROUPS        = YES
261 PERL_PATH              = /usr/bin/perl
262 #---------------------------------------------------------------------------
263 # Configuration options related to the dot tool
264 #---------------------------------------------------------------------------
265 CLASS_DIAGRAMS         = YES
266 MSCGEN_PATH            =
267 HIDE_UNDOC_RELATIONS   = YES
268 HAVE_DOT               = NO
269 DOT_NUM_THREADS        = 0
270 DOT_FONTNAME           = Helvetica
271 DOT_FONTSIZE           = 10
272 DOT_FONTPATH           =
273 CLASS_GRAPH            = YES
274 COLLABORATION_GRAPH    = YES
275 GROUP_GRAPHS           = YES
276 UML_LOOK               = NO
277 TEMPLATE_RELATIONS     = NO
278 INCLUDE_GRAPH          = YES
279 INCLUDED_BY_GRAPH      = YES
280 CALL_GRAPH             = NO
281 CALLER_GRAPH           = NO
282 GRAPHICAL_HIERARCHY    = YES
283 DIRECTORY_GRAPH        = YES
284 DOT_IMAGE_FORMAT       = png
285 DOT_PATH               =
286 DOTFILE_DIRS           =
287 MSCFILE_DIRS           =
288 DOT_GRAPH_MAX_NODES    = 50
289 MAX_DOT_GRAPH_DEPTH    = 0
290 DOT_TRANSPARENT        = NO
291 DOT_MULTI_TARGETS      = NO
292 GENERATE_LEGEND        = YES
293 DOT_CLEANUP            = YES