1 : |
agomez |
1 |
# Doxyfile 1.5.4
|
2 : |
|
|
# This is the configuration file used to generate Gadget documentation
|
3 : |
|
|
# To use this file you neeed to have the following software installed
|
4 : |
|
|
# 1) A recent version of 'doxygen' from www.doxygen.org
|
5 : |
|
|
# 2) A recent version of 'dot' from www.graphviz.org
|
6 : |
|
|
#
|
7 : |
|
|
# You will also need to adjust the paths to point to the correct directories
|
8 : |
|
|
# The default settings only generate the HTML output
|
9 : |
|
|
|
10 : |
|
|
#---------------------------------------------------------------------------
|
11 : |
|
|
# Project related configuration options
|
12 : |
|
|
#---------------------------------------------------------------------------
|
13 : |
|
|
DOXYFILE_ENCODING = UTF-8
|
14 : |
|
|
PROJECT_NAME = Gadget
|
15 : |
|
|
PROJECT_NUMBER =
|
16 : |
|
|
OUTPUT_DIRECTORY = /home/haf/james/gadget/doxygen/
|
17 : |
|
|
CREATE_SUBDIRS = NO
|
18 : |
|
|
OUTPUT_LANGUAGE = English
|
19 : |
|
|
BRIEF_MEMBER_DESC = YES
|
20 : |
|
|
REPEAT_BRIEF = YES
|
21 : |
|
|
ABBREVIATE_BRIEF =
|
22 : |
|
|
ALWAYS_DETAILED_SEC = YES
|
23 : |
|
|
INLINE_INHERITED_MEMB = YES
|
24 : |
|
|
FULL_PATH_NAMES = NO
|
25 : |
|
|
STRIP_FROM_PATH =
|
26 : |
|
|
STRIP_FROM_INC_PATH =
|
27 : |
|
|
SHORT_NAMES = NO
|
28 : |
|
|
JAVADOC_AUTOBRIEF = NO
|
29 : |
|
|
QT_AUTOBRIEF = NO
|
30 : |
|
|
MULTILINE_CPP_IS_BRIEF = NO
|
31 : |
|
|
DETAILS_AT_TOP = YES
|
32 : |
|
|
INHERIT_DOCS = YES
|
33 : |
|
|
SEPARATE_MEMBER_PAGES = NO
|
34 : |
|
|
TAB_SIZE = 2
|
35 : |
|
|
ALIASES =
|
36 : |
|
|
OPTIMIZE_OUTPUT_FOR_C = NO
|
37 : |
|
|
OPTIMIZE_OUTPUT_JAVA = NO
|
38 : |
|
|
BUILTIN_STL_SUPPORT = NO
|
39 : |
|
|
CPP_CLI_SUPPORT = NO
|
40 : |
|
|
SIP_SUPPORT = NO
|
41 : |
|
|
DISTRIBUTE_GROUP_DOC = NO
|
42 : |
|
|
SUBGROUPING = YES
|
43 : |
|
|
TYPEDEF_HIDES_STRUCT = NO
|
44 : |
|
|
#---------------------------------------------------------------------------
|
45 : |
|
|
# Build related configuration options
|
46 : |
|
|
#---------------------------------------------------------------------------
|
47 : |
|
|
EXTRACT_ALL = YES
|
48 : |
|
|
EXTRACT_PRIVATE = YES
|
49 : |
|
|
EXTRACT_STATIC = YES
|
50 : |
|
|
EXTRACT_LOCAL_CLASSES = YES
|
51 : |
|
|
EXTRACT_LOCAL_METHODS = NO
|
52 : |
|
|
EXTRACT_ANON_NSPACES = NO
|
53 : |
|
|
HIDE_UNDOC_MEMBERS = NO
|
54 : |
|
|
HIDE_UNDOC_CLASSES = NO
|
55 : |
|
|
HIDE_FRIEND_COMPOUNDS = NO
|
56 : |
|
|
HIDE_IN_BODY_DOCS = NO
|
57 : |
|
|
INTERNAL_DOCS = NO
|
58 : |
|
|
CASE_SENSE_NAMES = NO
|
59 : |
|
|
HIDE_SCOPE_NAMES = YES
|
60 : |
|
|
SHOW_INCLUDE_FILES = NO
|
61 : |
|
|
INLINE_INFO = YES
|
62 : |
|
|
SORT_MEMBER_DOCS = YES
|
63 : |
|
|
SORT_BRIEF_DOCS = YES
|
64 : |
|
|
SORT_BY_SCOPE_NAME = NO
|
65 : |
|
|
GENERATE_TODOLIST = NO
|
66 : |
|
|
GENERATE_TESTLIST = NO
|
67 : |
|
|
GENERATE_BUGLIST = NO
|
68 : |
|
|
GENERATE_DEPRECATEDLIST= YES
|
69 : |
|
|
ENABLED_SECTIONS =
|
70 : |
|
|
MAX_INITIALIZER_LINES = 30
|
71 : |
|
|
SHOW_USED_FILES = NO
|
72 : |
|
|
SHOW_DIRECTORIES = NO
|
73 : |
|
|
FILE_VERSION_FILTER =
|
74 : |
|
|
#---------------------------------------------------------------------------
|
75 : |
|
|
# configuration options related to warning and progress messages
|
76 : |
|
|
#---------------------------------------------------------------------------
|
77 : |
|
|
QUIET = NO
|
78 : |
|
|
WARNINGS = YES
|
79 : |
|
|
WARN_IF_UNDOCUMENTED = YES
|
80 : |
|
|
WARN_IF_DOC_ERROR = YES
|
81 : |
|
|
WARN_NO_PARAMDOC = NO
|
82 : |
|
|
WARN_FORMAT = "$file:$line: $text "
|
83 : |
|
|
WARN_LOGFILE = /home/haf/james/gadget/doxygen/gadget.err
|
84 : |
|
|
#---------------------------------------------------------------------------
|
85 : |
|
|
# configuration options related to the input files
|
86 : |
|
|
#---------------------------------------------------------------------------
|
87 : |
|
|
INPUT = /home/haf/james/gadget/doxygen/gadget
|
88 : |
|
|
INPUT_ENCODING = UTF-8
|
89 : |
|
|
FILE_PATTERNS = *.h
|
90 : |
|
|
RECURSIVE = NO
|
91 : |
|
|
EXCLUDE =
|
92 : |
|
|
EXCLUDE_SYMLINKS = YES
|
93 : |
|
|
EXCLUDE_PATTERNS =
|
94 : |
|
|
EXCLUDE_SYMBOLS =
|
95 : |
|
|
EXAMPLE_PATH =
|
96 : |
|
|
EXAMPLE_PATTERNS =
|
97 : |
|
|
EXAMPLE_RECURSIVE = NO
|
98 : |
|
|
IMAGE_PATH =
|
99 : |
|
|
INPUT_FILTER =
|
100 : |
|
|
FILTER_PATTERNS =
|
101 : |
|
|
FILTER_SOURCE_FILES = NO
|
102 : |
|
|
#---------------------------------------------------------------------------
|
103 : |
|
|
# configuration options related to source browsing
|
104 : |
|
|
#---------------------------------------------------------------------------
|
105 : |
|
|
SOURCE_BROWSER = NO
|
106 : |
|
|
INLINE_SOURCES = NO
|
107 : |
|
|
STRIP_CODE_COMMENTS = YES
|
108 : |
|
|
REFERENCED_BY_RELATION = YES
|
109 : |
|
|
REFERENCES_RELATION = YES
|
110 : |
|
|
REFERENCES_LINK_SOURCE = YES
|
111 : |
|
|
USE_HTAGS = NO
|
112 : |
|
|
VERBATIM_HEADERS = NO
|
113 : |
|
|
#---------------------------------------------------------------------------
|
114 : |
|
|
# configuration options related to the alphabetical class index
|
115 : |
|
|
#---------------------------------------------------------------------------
|
116 : |
|
|
ALPHABETICAL_INDEX = YES
|
117 : |
|
|
COLS_IN_ALPHA_INDEX = 3
|
118 : |
|
|
IGNORE_PREFIX =
|
119 : |
|
|
#---------------------------------------------------------------------------
|
120 : |
|
|
# configuration options related to the HTML output
|
121 : |
|
|
#---------------------------------------------------------------------------
|
122 : |
|
|
GENERATE_HTML = YES
|
123 : |
|
|
HTML_OUTPUT = html
|
124 : |
|
|
HTML_FILE_EXTENSION = .html
|
125 : |
|
|
HTML_HEADER =
|
126 : |
|
|
HTML_FOOTER =
|
127 : |
|
|
HTML_STYLESHEET =
|
128 : |
|
|
HTML_ALIGN_MEMBERS = YES
|
129 : |
|
|
GENERATE_HTMLHELP = NO
|
130 : |
|
|
HTML_DYNAMIC_SECTIONS = YES
|
131 : |
|
|
CHM_FILE =
|
132 : |
|
|
HHC_LOCATION =
|
133 : |
|
|
GENERATE_CHI = NO
|
134 : |
|
|
BINARY_TOC = NO
|
135 : |
|
|
TOC_EXPAND = NO
|
136 : |
|
|
DISABLE_INDEX = NO
|
137 : |
|
|
ENUM_VALUES_PER_LINE = 4
|
138 : |
|
|
GENERATE_TREEVIEW = NO
|
139 : |
|
|
TREEVIEW_WIDTH = 250
|
140 : |
|
|
#---------------------------------------------------------------------------
|
141 : |
|
|
# configuration options related to the LaTeX output
|
142 : |
|
|
#---------------------------------------------------------------------------
|
143 : |
|
|
GENERATE_LATEX = NO
|
144 : |
|
|
LATEX_OUTPUT = latex
|
145 : |
|
|
LATEX_CMD_NAME = latex
|
146 : |
|
|
MAKEINDEX_CMD_NAME = makeindex
|
147 : |
|
|
COMPACT_LATEX = YES
|
148 : |
|
|
PAPER_TYPE = a4wide
|
149 : |
|
|
EXTRA_PACKAGES =
|
150 : |
|
|
LATEX_HEADER =
|
151 : |
|
|
PDF_HYPERLINKS = NO
|
152 : |
|
|
USE_PDFLATEX = NO
|
153 : |
|
|
LATEX_BATCHMODE = NO
|
154 : |
|
|
LATEX_HIDE_INDICES = NO
|
155 : |
|
|
#---------------------------------------------------------------------------
|
156 : |
|
|
# configuration options related to the RTF output
|
157 : |
|
|
#---------------------------------------------------------------------------
|
158 : |
|
|
GENERATE_RTF = NO
|
159 : |
|
|
RTF_OUTPUT = rtf
|
160 : |
|
|
COMPACT_RTF = YES
|
161 : |
|
|
RTF_HYPERLINKS = NO
|
162 : |
|
|
RTF_STYLESHEET_FILE =
|
163 : |
|
|
RTF_EXTENSIONS_FILE =
|
164 : |
|
|
#---------------------------------------------------------------------------
|
165 : |
|
|
# configuration options related to the man page output
|
166 : |
|
|
#---------------------------------------------------------------------------
|
167 : |
|
|
GENERATE_MAN = NO
|
168 : |
|
|
MAN_OUTPUT = man
|
169 : |
|
|
MAN_EXTENSION = .3
|
170 : |
|
|
MAN_LINKS = NO
|
171 : |
|
|
#---------------------------------------------------------------------------
|
172 : |
|
|
# configuration options related to the XML output
|
173 : |
|
|
#---------------------------------------------------------------------------
|
174 : |
|
|
GENERATE_XML = NO
|
175 : |
|
|
XML_OUTPUT = xml
|
176 : |
|
|
XML_SCHEMA =
|
177 : |
|
|
XML_DTD =
|
178 : |
|
|
XML_PROGRAMLISTING = NO
|
179 : |
|
|
#---------------------------------------------------------------------------
|
180 : |
|
|
# configuration options for the AutoGen Definitions output
|
181 : |
|
|
#---------------------------------------------------------------------------
|
182 : |
|
|
GENERATE_AUTOGEN_DEF = NO
|
183 : |
|
|
#---------------------------------------------------------------------------
|
184 : |
|
|
# configuration options related to the Perl module output
|
185 : |
|
|
#---------------------------------------------------------------------------
|
186 : |
|
|
GENERATE_PERLMOD = NO
|
187 : |
|
|
PERLMOD_LATEX = NO
|
188 : |
|
|
PERLMOD_PRETTY = YES
|
189 : |
|
|
PERLMOD_MAKEVAR_PREFIX =
|
190 : |
|
|
#---------------------------------------------------------------------------
|
191 : |
|
|
# Configuration options related to the preprocessor
|
192 : |
|
|
#---------------------------------------------------------------------------
|
193 : |
|
|
ENABLE_PREPROCESSING = YES
|
194 : |
|
|
MACRO_EXPANSION = NO
|
195 : |
|
|
EXPAND_ONLY_PREDEF = NO
|
196 : |
|
|
SEARCH_INCLUDES = YES
|
197 : |
|
|
INCLUDE_PATH =
|
198 : |
|
|
INCLUDE_FILE_PATTERNS =
|
199 : |
|
|
PREDEFINED =
|
200 : |
|
|
EXPAND_AS_DEFINED =
|
201 : |
|
|
SKIP_FUNCTION_MACROS = YES
|
202 : |
|
|
#---------------------------------------------------------------------------
|
203 : |
|
|
# Configuration::additions related to external references
|
204 : |
|
|
#---------------------------------------------------------------------------
|
205 : |
|
|
TAGFILES =
|
206 : |
|
|
GENERATE_TAGFILE =
|
207 : |
|
|
ALLEXTERNALS = NO
|
208 : |
|
|
EXTERNAL_GROUPS = NO
|
209 : |
|
|
PERL_PATH = /usr/local/bin/perl
|
210 : |
|
|
#---------------------------------------------------------------------------
|
211 : |
|
|
# Configuration options related to the dot tool
|
212 : |
|
|
#---------------------------------------------------------------------------
|
213 : |
|
|
CLASS_DIAGRAMS = NO
|
214 : |
|
|
MSCGEN_PATH =
|
215 : |
|
|
HIDE_UNDOC_RELATIONS = NO
|
216 : |
|
|
HAVE_DOT = YES
|
217 : |
|
|
CLASS_GRAPH = YES
|
218 : |
|
|
COLLABORATION_GRAPH = YES
|
219 : |
|
|
GROUP_GRAPHS = YES
|
220 : |
|
|
UML_LOOK = NO
|
221 : |
|
|
TEMPLATE_RELATIONS = YES
|
222 : |
|
|
INCLUDE_GRAPH = NO
|
223 : |
|
|
INCLUDED_BY_GRAPH = NO
|
224 : |
|
|
CALL_GRAPH = NO
|
225 : |
|
|
CALLER_GRAPH = NO
|
226 : |
|
|
GRAPHICAL_HIERARCHY = NO
|
227 : |
|
|
DIRECTORY_GRAPH = YES
|
228 : |
|
|
DOT_IMAGE_FORMAT = png
|
229 : |
|
|
DOT_PATH = /usr/bin
|
230 : |
|
|
DOTFILE_DIRS =
|
231 : |
|
|
DOT_GRAPH_MAX_NODES = 50
|
232 : |
|
|
MAX_DOT_GRAPH_DEPTH = 0
|
233 : |
|
|
DOT_TRANSPARENT = NO
|
234 : |
|
|
DOT_MULTI_TARGETS = YES
|
235 : |
|
|
GENERATE_LEGEND = YES
|
236 : |
|
|
DOT_CLEANUP = YES
|
237 : |
|
|
#---------------------------------------------------------------------------
|
238 : |
|
|
# Configuration::additions related to the search engine
|
239 : |
|
|
#---------------------------------------------------------------------------
|
240 : |
|
|
SEARCHENGINE = NO
|