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