1 | # Doxygen config file for Phonon documentation, adapted from the KDE apidocs
|
---|
2 | # config file.
|
---|
3 |
|
---|
4 | #---------------------------------------------------------------------------
|
---|
5 | # Project related configuration options
|
---|
6 | #---------------------------------------------------------------------------
|
---|
7 | PROJECT_NAME = Qt
|
---|
8 | PROJECT_NUMBER = 4.5.1
|
---|
9 | OUTPUT_DIRECTORY = doc
|
---|
10 | CREATE_SUBDIRS = NO
|
---|
11 | OUTPUT_LANGUAGE = English
|
---|
12 | USE_WINDOWS_ENCODING = NO
|
---|
13 | BRIEF_MEMBER_DESC = YES
|
---|
14 | REPEAT_BRIEF = YES
|
---|
15 | ABBREVIATE_BRIEF = "The $name class" \
|
---|
16 | "The $name widget" \
|
---|
17 | "The $name file" \
|
---|
18 | is \
|
---|
19 | provides \
|
---|
20 | specifies \
|
---|
21 | contains \
|
---|
22 | represents \
|
---|
23 | a \
|
---|
24 | an \
|
---|
25 | the
|
---|
26 | ALWAYS_DETAILED_SEC = NO
|
---|
27 | INLINE_INHERITED_MEMB = NO
|
---|
28 | FULL_PATH_NAMES = NO
|
---|
29 | STRIP_FROM_PATH =
|
---|
30 | STRIP_FROM_INC_PATH =
|
---|
31 | SHORT_NAMES = NO
|
---|
32 | JAVADOC_AUTOBRIEF = NO
|
---|
33 | MULTILINE_CPP_IS_BRIEF = NO
|
---|
34 | DETAILS_AT_TOP = NO
|
---|
35 | INHERIT_DOCS = YES
|
---|
36 | SEPARATE_MEMBER_PAGES = NO
|
---|
37 | TAB_SIZE = 4
|
---|
38 | OPTIMIZE_OUTPUT_FOR_C = NO
|
---|
39 | OPTIMIZE_OUTPUT_JAVA = NO
|
---|
40 | BUILTIN_STL_SUPPORT = NO
|
---|
41 | DISTRIBUTE_GROUP_DOC = NO
|
---|
42 | SUBGROUPING = YES
|
---|
43 | #---------------------------------------------------------------------------
|
---|
44 | # Build related configuration options
|
---|
45 | #---------------------------------------------------------------------------
|
---|
46 | EXTRACT_ALL = NO
|
---|
47 | EXTRACT_PRIVATE = NO
|
---|
48 | EXTRACT_STATIC = YES
|
---|
49 | EXTRACT_LOCAL_CLASSES = YES
|
---|
50 | EXTRACT_LOCAL_METHODS = NO
|
---|
51 | HIDE_UNDOC_MEMBERS = NO
|
---|
52 | HIDE_UNDOC_CLASSES = YES
|
---|
53 | HIDE_FRIEND_COMPOUNDS = YES
|
---|
54 | HIDE_IN_BODY_DOCS = NO
|
---|
55 | INTERNAL_DOCS = NO
|
---|
56 | CASE_SENSE_NAMES = YES
|
---|
57 | HIDE_SCOPE_NAMES = NO
|
---|
58 | SHOW_INCLUDE_FILES = YES
|
---|
59 | INLINE_INFO = YES
|
---|
60 | SORT_MEMBER_DOCS = YES
|
---|
61 | SORT_BRIEF_DOCS = NO
|
---|
62 | SORT_BY_SCOPE_NAME = NO
|
---|
63 | GENERATE_TODOLIST = NO
|
---|
64 | GENERATE_TESTLIST = NO
|
---|
65 | GENERATE_BUGLIST = NO
|
---|
66 | GENERATE_DEPRECATEDLIST= NO
|
---|
67 | ENABLED_SECTIONS =
|
---|
68 | MAX_INITIALIZER_LINES = 30
|
---|
69 | SHOW_USED_FILES = YES
|
---|
70 | SHOW_DIRECTORIES = NO
|
---|
71 | FILE_VERSION_FILTER =
|
---|
72 | #---------------------------------------------------------------------------
|
---|
73 | # configuration options related to warning and progress messages
|
---|
74 | #---------------------------------------------------------------------------
|
---|
75 | QUIET = NO
|
---|
76 | WARNINGS = YES
|
---|
77 | WARN_IF_UNDOCUMENTED = YES
|
---|
78 | WARN_IF_DOC_ERROR = YES
|
---|
79 | WARN_NO_PARAMDOC = YES
|
---|
80 | WARN_FORMAT = "$file:$line: $text"
|
---|
81 | WARN_LOGFILE = doxygen.log
|
---|
82 | #---------------------------------------------------------------------------
|
---|
83 | # configuration options related to the input files
|
---|
84 | #---------------------------------------------------------------------------
|
---|
85 | INPUT = src/3rdparty/kdelibs/phonon
|
---|
86 | FILE_PATTERNS = *.cpp \
|
---|
87 | *.h \
|
---|
88 | *.dox
|
---|
89 | RECURSIVE = NO
|
---|
90 | EXCLUDE =
|
---|
91 | EXCLUDE_SYMLINKS = NO
|
---|
92 | EXCLUDE_PATTERNS =
|
---|
93 | EXAMPLE_PATH =
|
---|
94 | EXAMPLE_PATTERNS = *
|
---|
95 | EXAMPLE_RECURSIVE = NO
|
---|
96 | IMAGE_PATH =
|
---|
97 | INPUT_FILTER =
|
---|
98 | FILTER_PATTERNS =
|
---|
99 | FILTER_SOURCE_FILES = NO
|
---|
100 | #---------------------------------------------------------------------------
|
---|
101 | # configuration options related to source browsing
|
---|
102 | #---------------------------------------------------------------------------
|
---|
103 | SOURCE_BROWSER = NO
|
---|
104 | INLINE_SOURCES = NO
|
---|
105 | STRIP_CODE_COMMENTS = YES
|
---|
106 | REFERENCED_BY_RELATION = YES
|
---|
107 | REFERENCES_RELATION = YES
|
---|
108 | REFERENCES_LINK_SOURCE = YES
|
---|
109 | USE_HTAGS = NO
|
---|
110 | VERBATIM_HEADERS = NO
|
---|
111 | #---------------------------------------------------------------------------
|
---|
112 | # configuration options related to the alphabetical class index
|
---|
113 | #---------------------------------------------------------------------------
|
---|
114 | ALPHABETICAL_INDEX = NO
|
---|
115 | COLS_IN_ALPHA_INDEX = 5
|
---|
116 | IGNORE_PREFIX =
|
---|
117 | #---------------------------------------------------------------------------
|
---|
118 | # configuration options related to the HTML output
|
---|
119 | #---------------------------------------------------------------------------
|
---|
120 | GENERATE_HTML = YES
|
---|
121 | HTML_OUTPUT = html-phonon
|
---|
122 | HTML_FILE_EXTENSION = .html
|
---|
123 | HTML_HEADER = tools/doxygen/config/header.html
|
---|
124 | HTML_FOOTER = tools/doxygen/config/footer.html
|
---|
125 | HTML_STYLESHEET = tools/doxygen/config/phonon.css
|
---|
126 | HTML_ALIGN_MEMBERS = NO
|
---|
127 | GENERATE_HTMLHELP = NO
|
---|
128 | CHM_FILE =
|
---|
129 | HHC_LOCATION =
|
---|
130 | GENERATE_CHI = NO
|
---|
131 | BINARY_TOC = NO
|
---|
132 | TOC_EXPAND = NO
|
---|
133 | DISABLE_INDEX = YES
|
---|
134 | ENUM_VALUES_PER_LINE = 4
|
---|
135 | GENERATE_TREEVIEW = NO
|
---|
136 | TREEVIEW_WIDTH = 250
|
---|
137 | #---------------------------------------------------------------------------
|
---|
138 | # configuration options related to the LaTeX output
|
---|
139 | #---------------------------------------------------------------------------
|
---|
140 | GENERATE_LATEX = NO
|
---|
141 | #---------------------------------------------------------------------------
|
---|
142 | # configuration options related to the RTF output
|
---|
143 | #---------------------------------------------------------------------------
|
---|
144 | GENERATE_RTF = NO
|
---|
145 | #---------------------------------------------------------------------------
|
---|
146 | # configuration options related to the man page output
|
---|
147 | #---------------------------------------------------------------------------
|
---|
148 | GENERATE_MAN = NO
|
---|
149 | #---------------------------------------------------------------------------
|
---|
150 | # configuration options related to the XML output
|
---|
151 | #---------------------------------------------------------------------------
|
---|
152 | GENERATE_XML = NO
|
---|
153 | XML_OUTPUT = xml
|
---|
154 | XML_SCHEMA =
|
---|
155 | XML_DTD =
|
---|
156 | XML_PROGRAMLISTING = NO
|
---|
157 | #---------------------------------------------------------------------------
|
---|
158 | # configuration options for the AutoGen Definitions output
|
---|
159 | #---------------------------------------------------------------------------
|
---|
160 | GENERATE_AUTOGEN_DEF = NO
|
---|
161 | #---------------------------------------------------------------------------
|
---|
162 | # configuration options related to the Perl module output
|
---|
163 | #---------------------------------------------------------------------------
|
---|
164 | GENERATE_PERLMOD = NO
|
---|
165 | #---------------------------------------------------------------------------
|
---|
166 | # Configuration options related to the preprocessor
|
---|
167 | #---------------------------------------------------------------------------
|
---|
168 | ENABLE_PREPROCESSING = YES
|
---|
169 | MACRO_EXPANSION = NO
|
---|
170 | EXPAND_ONLY_PREDEF = NO
|
---|
171 | SEARCH_INCLUDES = YES
|
---|
172 | INCLUDE_PATH =
|
---|
173 | INCLUDE_FILE_PATTERNS =
|
---|
174 | PREDEFINED =
|
---|
175 | EXPAND_AS_DEFINED =
|
---|
176 | SKIP_FUNCTION_MACROS = YES
|
---|
177 | #---------------------------------------------------------------------------
|
---|
178 | # Configuration::additions related to external references
|
---|
179 | #---------------------------------------------------------------------------
|
---|
180 | TAGFILES = doc/indexes/qt.tags
|
---|
181 | GENERATE_TAGFILE = doc/indexes/phonon.tags
|
---|
182 | ALLEXTERNALS = NO
|
---|
183 | EXTERNAL_GROUPS = YES
|
---|
184 | PERL_PATH = /usr/bin/perl
|
---|
185 | #---------------------------------------------------------------------------
|
---|
186 | # Configuration options related to the dot tool
|
---|
187 | #---------------------------------------------------------------------------
|
---|
188 | CLASS_DIAGRAMS = NO
|
---|
189 | #---------------------------------------------------------------------------
|
---|
190 | # Configuration::additions related to the search engine
|
---|
191 | #---------------------------------------------------------------------------
|
---|
192 | SEARCHENGINE = NO
|
---|
193 |
|
---|
194 |
|
---|
195 | ### KDE Settings
|
---|
196 | ALIASES = \
|
---|
197 | "intern=\par<b>Internal use only.</b>" \
|
---|
198 | "reimp=\par<b>Reimplemented from superclass.</b>" \
|
---|
199 | "obsolete=@deprecated" \
|
---|
200 | "feature=\xrefitem features \"Feature(s)\" \"Features\"" \
|
---|
201 | "maintainer=\xrefitem maintainers \"Maintainer(s)\" \"Maintainers\"" \
|
---|
202 | "unmaintained=\xrefitem unmaintained \"Unmaintained\" \"Unmaintained\"" \
|
---|
203 | "requirement=\xrefitem requirements \"Requirement(s)\" \"Requirements\"" \
|
---|
204 | "faq=\xrefitem FAQ \"F.A.Q.\" \"F.A.Q.\"" \
|
---|
205 | "authors=\xrefitem authors \"Author(s)\" \"Authors\"" \
|
---|
206 | "maintainers=\xrefitem maintainers \"Maintainer(s)\" \"Maintainers\"" \
|
---|
207 | "port4=\xrefitem port4 \"KDE 4 Porting Guide\" \"KDE 4 Porting Guide\"" \
|
---|
208 | "glossary=\xrefitem glossary \"KDE 4 Glossary\" \"KDE 4 Glossary\"" \
|
---|
209 | "acronym=\b "\
|
---|
210 | "licenses=\xrefitem licenses \"License(s)\" \"Licenses\"" \
|
---|
211 | "short=@brief "\
|
---|
212 | "FIXME=\xrefitem fixme \"Fixme\" \"Fixme\"" \
|
---|
213 | "bc=\xrefitem bc \"Binary Compatible\" \"Binary Compatible\"" \
|
---|
214 | "artistic=<a href=\"http://www.opensource.org/licenses/artistic-license.php\">Artistic</a>" \
|
---|
215 | "bsd=<a href=\"http://www.xfree86.org/3.3.6/COPYRIGHT2.html#5\">BSD</a>" \
|
---|
216 | "x11=<a href=\"http://www.xfree86.org/3.3.6/COPYRIGHT2.html#3\">X11</a>" \
|
---|
217 | "gpl=<a href=\"http://www.fsf.org/licensing/licenses/gpl.html#SEC1\">GPL</a>" \
|
---|
218 | "lgpl=<a href=\"http://www.fsf.org/licensing/licenses/lgpl.html#SEC1\">LGPL</a>" \
|
---|
219 | "qpl=<a href=\"http://qtsoftware.com/products/qt/licenses\">QPL</a>"
|
---|
220 |
|
---|