|
1 # |
|
2 # Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies). |
|
3 # All rights reserved. |
|
4 # This component and the accompanying materials are made available |
|
5 # under the terms of "Eclipse Public License v1.0" |
|
6 # which accompanies this distribution, and is available |
|
7 # at the URL "http://www.eclipse.org/legal/epl-v10.html". |
|
8 # |
|
9 # Initial Contributors: |
|
10 # Nokia Corporation - initial contribution. |
|
11 # |
|
12 # Contributors: |
|
13 # |
|
14 # Description: Doxygen 1.3.6 configuration file for Active Palette 2 |
|
15 # |
|
16 # |
|
17 |
|
18 # |
|
19 # INSTRUCTIONS: How to Customize the Doxyfile for Your Component |
|
20 # |
|
21 # The following settings need to be customized: |
|
22 # - PROJECT_NAME (name of your component) |
|
23 # - PROJECT_NUMBER (if a version number has been assigned for the component) |
|
24 # |
|
25 # Other useful settings: |
|
26 # - IGNORE_PREFIX (prefixes ignored in the alphabetical index) |
|
27 # |
|
28 |
|
29 #--------------------------------------------------------------------------- |
|
30 # Project related configuration options |
|
31 #--------------------------------------------------------------------------- |
|
32 PROJECT_NAME = "Active Palette 2" |
|
33 PROJECT_NUMBER = |
|
34 OUTPUT_DIRECTORY = "../docs/api" |
|
35 OUTPUT_LANGUAGE = English |
|
36 USE_WINDOWS_ENCODING = NO |
|
37 BRIEF_MEMBER_DESC = YES |
|
38 REPEAT_BRIEF = YES |
|
39 ABBREVIATE_BRIEF = "The $name class" \ |
|
40 "The $name widget" \ |
|
41 "The $name file" \ |
|
42 is \ |
|
43 provides \ |
|
44 specifies \ |
|
45 contains \ |
|
46 represents \ |
|
47 a \ |
|
48 an \ |
|
49 the |
|
50 ALWAYS_DETAILED_SEC = NO |
|
51 INLINE_INHERITED_MEMB = NO |
|
52 FULL_PATH_NAMES = NO |
|
53 STRIP_FROM_PATH = |
|
54 SHORT_NAMES = NO |
|
55 JAVADOC_AUTOBRIEF = YES |
|
56 MULTILINE_CPP_IS_BRIEF = NO |
|
57 DETAILS_AT_TOP = YES |
|
58 INHERIT_DOCS = YES |
|
59 DISTRIBUTE_GROUP_DOC = NO |
|
60 TAB_SIZE = 4 |
|
61 ALIASES = panic=@exception \ |
|
62 leave=@exception \ |
|
63 "internalTechnology=@par Internal technology" \ |
|
64 "internalComponent=@par Internal component" \ |
|
65 "internalAll=@par Internal all" \ |
|
66 "publishedPartner=@par Published-partner" \ |
|
67 "publishedAll=@par Published-all" \ |
|
68 "prototype=@par Prototype" \ |
|
69 "interim=@par Interim" \ |
|
70 "released=@par Released" \ |
|
71 "removed=@par Removed" \ |
|
72 "test=@par Test" \ |
|
73 "realtime=@par Realtime" \ |
|
74 "beginAPI=@name Exported API\n @{" \ |
|
75 "endAPI=@}" |
|
76 OPTIMIZE_OUTPUT_FOR_C = NO |
|
77 OPTIMIZE_OUTPUT_JAVA = NO |
|
78 SUBGROUPING = YES |
|
79 #--------------------------------------------------------------------------- |
|
80 # Build related configuration options |
|
81 #--------------------------------------------------------------------------- |
|
82 EXTRACT_ALL = YES |
|
83 EXTRACT_PRIVATE = YES |
|
84 EXTRACT_STATIC = YES |
|
85 EXTRACT_LOCAL_CLASSES = YES |
|
86 EXTRACT_LOCAL_METHODS = YES |
|
87 HIDE_UNDOC_MEMBERS = NO |
|
88 HIDE_UNDOC_CLASSES = NO |
|
89 HIDE_FRIEND_COMPOUNDS = NO |
|
90 HIDE_IN_BODY_DOCS = NO |
|
91 INTERNAL_DOCS = NO |
|
92 CASE_SENSE_NAMES = NO |
|
93 HIDE_SCOPE_NAMES = NO |
|
94 SHOW_INCLUDE_FILES = YES |
|
95 INLINE_INFO = YES |
|
96 SORT_MEMBER_DOCS = YES |
|
97 SORT_BRIEF_DOCS = YES |
|
98 SORT_BY_SCOPE_NAME = NO |
|
99 GENERATE_TODOLIST = YES |
|
100 GENERATE_TESTLIST = YES |
|
101 GENERATE_BUGLIST = YES |
|
102 GENERATE_DEPRECATEDLIST= YES |
|
103 ENABLED_SECTIONS = |
|
104 MAX_INITIALIZER_LINES = 30 |
|
105 SHOW_USED_FILES = YES |
|
106 SHOW_DIRECTORIES = YES |
|
107 #--------------------------------------------------------------------------- |
|
108 # configuration options related to warning and progress messages |
|
109 #--------------------------------------------------------------------------- |
|
110 QUIET = NO |
|
111 WARNINGS = YES |
|
112 WARN_IF_UNDOCUMENTED = YES |
|
113 WARN_IF_DOC_ERROR = YES |
|
114 WARN_FORMAT = "$file:$line: $text" |
|
115 WARN_LOGFILE = |
|
116 #--------------------------------------------------------------------------- |
|
117 # configuration options related to the input files |
|
118 #--------------------------------------------------------------------------- |
|
119 INPUT = ../inc ../src |
|
120 FILE_PATTERNS = *.c \ |
|
121 *.cc \ |
|
122 *.cpp \ |
|
123 *.h \ |
|
124 *.hh \ |
|
125 *.hrh \ |
|
126 *.dox |
|
127 RECURSIVE = YES |
|
128 EXCLUDE = |
|
129 EXCLUDE_SYMLINKS = NO |
|
130 EXCLUDE_PATTERNS = |
|
131 EXAMPLE_PATH = |
|
132 EXAMPLE_PATTERNS = |
|
133 EXAMPLE_RECURSIVE = NO |
|
134 IMAGE_PATH = |
|
135 INPUT_FILTER = |
|
136 FILTER_SOURCE_FILES = NO |
|
137 #--------------------------------------------------------------------------- |
|
138 # configuration options related to source browsing |
|
139 #--------------------------------------------------------------------------- |
|
140 SOURCE_BROWSER = YES |
|
141 INLINE_SOURCES = NO |
|
142 STRIP_CODE_COMMENTS = YES |
|
143 REFERENCED_BY_RELATION = YES |
|
144 REFERENCES_RELATION = YES |
|
145 VERBATIM_HEADERS = YES |
|
146 #--------------------------------------------------------------------------- |
|
147 # configuration options related to the alphabetical class index |
|
148 #--------------------------------------------------------------------------- |
|
149 ALPHABETICAL_INDEX = YES |
|
150 COLS_IN_ALPHA_INDEX = 2 |
|
151 IGNORE_PREFIX = "TActivePalette2" "NActivePalette2" "CActivePalette2" "RActivePalette2" "MActivePalette2" "TAP2" "NAP2" "CAP2" "ActivePalette2" "MActivePalette" "CActivePalette" "T" "M" "C" "N" |
|
152 #--------------------------------------------------------------------------- |
|
153 # configuration options related to the HTML output |
|
154 #--------------------------------------------------------------------------- |
|
155 GENERATE_HTML = YES |
|
156 HTML_OUTPUT = html |
|
157 HTML_FILE_EXTENSION = .html |
|
158 HTML_HEADER = |
|
159 HTML_FOOTER = |
|
160 HTML_STYLESHEET = |
|
161 HTML_ALIGN_MEMBERS = YES |
|
162 GENERATE_HTMLHELP = YES |
|
163 CHM_FILE = |
|
164 HHC_LOCATION = |
|
165 GENERATE_CHI = NO |
|
166 BINARY_TOC = NO |
|
167 TOC_EXPAND = NO |
|
168 DISABLE_INDEX = NO |
|
169 ENUM_VALUES_PER_LINE = 4 |
|
170 GENERATE_TREEVIEW = NO |
|
171 TREEVIEW_WIDTH = 250 |
|
172 #--------------------------------------------------------------------------- |
|
173 # configuration options related to the LaTeX output |
|
174 #--------------------------------------------------------------------------- |
|
175 GENERATE_LATEX = NO |
|
176 LATEX_OUTPUT = latex |
|
177 LATEX_CMD_NAME = latex |
|
178 MAKEINDEX_CMD_NAME = makeindex |
|
179 COMPACT_LATEX = NO |
|
180 PAPER_TYPE = a4wide |
|
181 EXTRA_PACKAGES = |
|
182 LATEX_HEADER = |
|
183 PDF_HYPERLINKS = NO |
|
184 USE_PDFLATEX = NO |
|
185 LATEX_BATCHMODE = NO |
|
186 LATEX_HIDE_INDICES = NO |
|
187 #--------------------------------------------------------------------------- |
|
188 # configuration options related to the RTF output |
|
189 #--------------------------------------------------------------------------- |
|
190 GENERATE_RTF = NO |
|
191 RTF_OUTPUT = rtf |
|
192 COMPACT_RTF = NO |
|
193 RTF_HYPERLINKS = NO |
|
194 RTF_STYLESHEET_FILE = |
|
195 RTF_EXTENSIONS_FILE = |
|
196 #--------------------------------------------------------------------------- |
|
197 # configuration options related to the man page output |
|
198 #--------------------------------------------------------------------------- |
|
199 GENERATE_MAN = NO |
|
200 MAN_OUTPUT = man |
|
201 MAN_EXTENSION = .3 |
|
202 MAN_LINKS = NO |
|
203 #--------------------------------------------------------------------------- |
|
204 # configuration options related to the XML output |
|
205 #--------------------------------------------------------------------------- |
|
206 GENERATE_XML = NO |
|
207 XML_OUTPUT = xml |
|
208 XML_SCHEMA = |
|
209 XML_DTD = |
|
210 XML_PROGRAMLISTING = YES |
|
211 #--------------------------------------------------------------------------- |
|
212 # configuration options for the AutoGen Definitions output |
|
213 #--------------------------------------------------------------------------- |
|
214 GENERATE_AUTOGEN_DEF = NO |
|
215 #--------------------------------------------------------------------------- |
|
216 # configuration options related to the Perl module output |
|
217 #--------------------------------------------------------------------------- |
|
218 GENERATE_PERLMOD = NO |
|
219 PERLMOD_LATEX = NO |
|
220 PERLMOD_PRETTY = YES |
|
221 PERLMOD_MAKEVAR_PREFIX = |
|
222 #--------------------------------------------------------------------------- |
|
223 # Configuration options related to the preprocessor |
|
224 #--------------------------------------------------------------------------- |
|
225 ENABLE_PREPROCESSING = YES |
|
226 MACRO_EXPANSION = NO |
|
227 EXPAND_ONLY_PREDEF = NO |
|
228 SEARCH_INCLUDES = YES |
|
229 INCLUDE_PATH = |
|
230 INCLUDE_FILE_PATTERNS = |
|
231 PREDEFINED = |
|
232 EXPAND_AS_DEFINED = |
|
233 SKIP_FUNCTION_MACROS = YES |
|
234 #--------------------------------------------------------------------------- |
|
235 # Configuration::additions related to external references |
|
236 #--------------------------------------------------------------------------- |
|
237 TAGFILES = |
|
238 GENERATE_TAGFILE = |
|
239 ALLEXTERNALS = NO |
|
240 EXTERNAL_GROUPS = YES |
|
241 PERL_PATH = /usr/bin/perl |
|
242 #--------------------------------------------------------------------------- |
|
243 # Configuration options related to the dot tool |
|
244 #--------------------------------------------------------------------------- |
|
245 CLASS_DIAGRAMS = YES |
|
246 HIDE_UNDOC_RELATIONS = YES |
|
247 HAVE_DOT = NO |
|
248 CLASS_GRAPH = YES |
|
249 COLLABORATION_GRAPH = NO |
|
250 UML_LOOK = YES |
|
251 TEMPLATE_RELATIONS = NO |
|
252 INCLUDE_GRAPH = YES |
|
253 INCLUDED_BY_GRAPH = YES |
|
254 CALL_GRAPH = NO |
|
255 GRAPHICAL_HIERARCHY = YES |
|
256 DIRECTORY_GRAPH = YES |
|
257 DOT_IMAGE_FORMAT = png |
|
258 DOT_PATH = |
|
259 DOTFILE_DIRS = |
|
260 MAX_DOT_GRAPH_WIDTH = 1024 |
|
261 MAX_DOT_GRAPH_HEIGHT = 1024 |
|
262 MAX_DOT_GRAPH_DEPTH = 0 |
|
263 GENERATE_LEGEND = YES |
|
264 DOT_CLEANUP = YES |
|
265 #--------------------------------------------------------------------------- |
|
266 # Configuration::additions related to the search engine |
|
267 #--------------------------------------------------------------------------- |
|
268 SEARCHENGINE = NO |