RPA Toolkit
Work on the documentation layout.
[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/introduction.txt \
100                          ../../rpa/doc/overview.txt
101 INPUT_ENCODING         = UTF-8
102 FILE_PATTERNS          =
103 RECURSIVE              = NO
104 EXCLUDE                =
105 EXCLUDE_SYMLINKS       = NO
106 EXCLUDE_PATTERNS       =
107 EXCLUDE_SYMBOLS        =
108 EXAMPLE_PATH           =
109 EXAMPLE_PATTERNS       =
110 EXAMPLE_RECURSIVE      = NO
111 IMAGE_PATH             =
112 INPUT_FILTER           =
113 FILTER_PATTERNS        =
114 FILTER_SOURCE_FILES    = NO
115 FILTER_SOURCE_PATTERNS =
116 #---------------------------------------------------------------------------
117 # configuration options related to source browsing
118 #---------------------------------------------------------------------------
119 SOURCE_BROWSER         = NO
120 INLINE_SOURCES         = NO
121 STRIP_CODE_COMMENTS    = YES
122 REFERENCED_BY_RELATION = NO
123 REFERENCES_RELATION    = NO
124 REFERENCES_LINK_SOURCE = YES
125 USE_HTAGS              = NO
126 VERBATIM_HEADERS       = YES
127 #---------------------------------------------------------------------------
128 # configuration options related to the alphabetical class index
129 #---------------------------------------------------------------------------
130 ALPHABETICAL_INDEX     = YES
131 COLS_IN_ALPHA_INDEX    = 5
132 IGNORE_PREFIX          =
133 #---------------------------------------------------------------------------
134 # configuration options related to the HTML output
135 #---------------------------------------------------------------------------
136 GENERATE_HTML          = YES
137 HTML_OUTPUT            = html
138 HTML_FILE_EXTENSION    = .php
139 HTML_HEADER            = header.html
140 HTML_FOOTER            = footer.html
141 HTML_STYLESHEET        = customdoxygen.css
142 HTML_EXTRA_FILES       = artwork/logoRPA.png artwork/bannerleft.png artwork/bannerright.png artwork/logoR.png style.css
143 HTML_COLORSTYLE_HUE    = 220
144 HTML_COLORSTYLE_SAT    = 100
145 HTML_COLORSTYLE_GAMMA  = 80
146 HTML_TIMESTAMP         = YES
147 HTML_ALIGN_MEMBERS     = YES
148 HTML_DYNAMIC_SECTIONS  = NO
149 GENERATE_DOCSET        = NO
150 DOCSET_FEEDNAME        = "Doxygen generated docs"
151 DOCSET_BUNDLE_ID       = org.doxygen.Project
152 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
153 DOCSET_PUBLISHER_NAME  = Publisher
154 GENERATE_HTMLHELP      = YES
155 CHM_FILE               =
156 HHC_LOCATION           =
157 GENERATE_CHI           = NO
158 CHM_INDEX_ENCODING     =
159 BINARY_TOC             = NO
160 TOC_EXPAND             = YES
161 GENERATE_QHP           = NO
162 QCH_FILE               =
163 QHP_NAMESPACE          = org.doxygen.Project
164 QHP_VIRTUAL_FOLDER     = doc
165 QHP_CUST_FILTER_NAME   =
166 QHP_CUST_FILTER_ATTRS  =
167 QHP_SECT_FILTER_ATTRS  =
168 QHG_LOCATION           =
169 GENERATE_ECLIPSEHELP   = NO
170 ECLIPSE_DOC_ID         = org.doxygen.Project
171 DISABLE_INDEX          = NO
172 ENUM_VALUES_PER_LINE   = 4
173 GENERATE_TREEVIEW      = NO
174 USE_INLINE_TREES       = NO
175 TREEVIEW_WIDTH         = 250
176 EXT_LINKS_IN_WINDOW    = NO
177 FORMULA_FONTSIZE       = 10
178 FORMULA_TRANSPARENT    = YES
179 USE_MATHJAX            = NO
180 MATHJAX_RELPATH        = http://www.mathjax.org/mathjax
181 SEARCHENGINE           = YES
182 SERVER_BASED_SEARCH    = NO
183 #---------------------------------------------------------------------------
184 # configuration options related to the LaTeX output
185 #---------------------------------------------------------------------------
186 GENERATE_LATEX         = NO
187 LATEX_OUTPUT           = latex
188 LATEX_CMD_NAME         = latex
189 MAKEINDEX_CMD_NAME     = makeindex
190 COMPACT_LATEX          = NO
191 PAPER_TYPE             = a4
192 EXTRA_PACKAGES         =
193 LATEX_HEADER           =
194 LATEX_FOOTER           =
195 PDF_HYPERLINKS         = YES
196 USE_PDFLATEX           = YES
197 LATEX_BATCHMODE        = NO
198 LATEX_HIDE_INDICES     = NO
199 LATEX_SOURCE_CODE      = NO
200 #---------------------------------------------------------------------------
201 # configuration options related to the RTF output
202 #---------------------------------------------------------------------------
203 GENERATE_RTF           = NO
204 RTF_OUTPUT             = rtf
205 COMPACT_RTF            = NO
206 RTF_HYPERLINKS         = NO
207 RTF_STYLESHEET_FILE    =
208 RTF_EXTENSIONS_FILE    =
209 #---------------------------------------------------------------------------
210 # configuration options related to the man page output
211 #---------------------------------------------------------------------------
212 GENERATE_MAN           = NO
213 MAN_OUTPUT             = man
214 MAN_EXTENSION          = .3
215 MAN_LINKS              = NO
216 #---------------------------------------------------------------------------
217 # configuration options related to the XML output
218 #---------------------------------------------------------------------------
219 GENERATE_XML           = NO
220 XML_OUTPUT             = xml
221 XML_SCHEMA             =
222 XML_DTD                =
223 XML_PROGRAMLISTING     = YES
224 #---------------------------------------------------------------------------
225 # configuration options for the AutoGen Definitions output
226 #---------------------------------------------------------------------------
227 GENERATE_AUTOGEN_DEF   = NO
228 #---------------------------------------------------------------------------
229 # configuration options related to the Perl module output
230 #---------------------------------------------------------------------------
231 GENERATE_PERLMOD       = NO
232 PERLMOD_LATEX          = NO
233 PERLMOD_PRETTY         = YES
234 PERLMOD_MAKEVAR_PREFIX =
235 #---------------------------------------------------------------------------
236 # Configuration options related to the preprocessor
237 #---------------------------------------------------------------------------
238 ENABLE_PREPROCESSING   = YES
239 MACRO_EXPANSION        = NO
240 EXPAND_ONLY_PREDEF     = NO
241 SEARCH_INCLUDES        = YES
242 INCLUDE_PATH           =
243 INCLUDE_FILE_PATTERNS  =
244 PREDEFINED             =
245 EXPAND_AS_DEFINED      =
246 SKIP_FUNCTION_MACROS   = YES
247 #---------------------------------------------------------------------------
248 # Configuration::additions related to external references
249 #---------------------------------------------------------------------------
250 TAGFILES               =
251 GENERATE_TAGFILE       =
252 ALLEXTERNALS           = NO
253 EXTERNAL_GROUPS        = YES
254 PERL_PATH              = /usr/bin/perl
255 #---------------------------------------------------------------------------
256 # Configuration options related to the dot tool
257 #---------------------------------------------------------------------------
258 CLASS_DIAGRAMS         = YES
259 MSCGEN_PATH            =
260 HIDE_UNDOC_RELATIONS   = YES
261 HAVE_DOT               = NO
262 DOT_NUM_THREADS        = 0
263 DOT_FONTNAME           = Helvetica
264 DOT_FONTSIZE           = 10
265 DOT_FONTPATH           =
266 CLASS_GRAPH            = YES
267 COLLABORATION_GRAPH    = YES
268 GROUP_GRAPHS           = YES
269 UML_LOOK               = NO
270 TEMPLATE_RELATIONS     = NO
271 INCLUDE_GRAPH          = YES
272 INCLUDED_BY_GRAPH      = YES
273 CALL_GRAPH             = NO
274 CALLER_GRAPH           = NO
275 GRAPHICAL_HIERARCHY    = YES
276 DIRECTORY_GRAPH        = YES
277 DOT_IMAGE_FORMAT       = png
278 DOT_PATH               =
279 DOTFILE_DIRS           =
280 MSCFILE_DIRS           =
281 DOT_GRAPH_MAX_NODES    = 50
282 MAX_DOT_GRAPH_DEPTH    = 0
283 DOT_TRANSPARENT        = NO
284 DOT_MULTI_TARGETS      = NO
285 GENERATE_LEGEND        = YES
286 DOT_CLEANUP            = YES