source: branches/vendor/trolltech/qt/current/tools/doxygen/config/phonon.doxyfile @ 2

Last change on this file since 2 was 2, checked in by Dmitry A. Kuminov, 13 years ago

Initially imported qt-all-opensource-src-4.5.1 from Trolltech.

File size: 9.1 KB
Line 
1# Doxygen config file for Phonon documentation, adapted from the KDE apidocs
2# config file.
3
4#---------------------------------------------------------------------------
5# Project related configuration options
6#---------------------------------------------------------------------------
7PROJECT_NAME           = Qt
8PROJECT_NUMBER         = 4.5.1
9OUTPUT_DIRECTORY       = doc
10CREATE_SUBDIRS         = NO
11OUTPUT_LANGUAGE        = English
12USE_WINDOWS_ENCODING   = NO
13BRIEF_MEMBER_DESC      = YES
14REPEAT_BRIEF           = YES
15ABBREVIATE_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
26ALWAYS_DETAILED_SEC    = NO
27INLINE_INHERITED_MEMB  = NO
28FULL_PATH_NAMES        = NO
29STRIP_FROM_PATH        =
30STRIP_FROM_INC_PATH    =
31SHORT_NAMES            = NO
32JAVADOC_AUTOBRIEF      = NO
33MULTILINE_CPP_IS_BRIEF = NO
34DETAILS_AT_TOP         = NO
35INHERIT_DOCS           = YES
36SEPARATE_MEMBER_PAGES  = NO
37TAB_SIZE               = 4
38OPTIMIZE_OUTPUT_FOR_C  = NO
39OPTIMIZE_OUTPUT_JAVA   = NO
40BUILTIN_STL_SUPPORT    = NO
41DISTRIBUTE_GROUP_DOC   = NO
42SUBGROUPING            = YES
43#---------------------------------------------------------------------------
44# Build related configuration options
45#---------------------------------------------------------------------------
46EXTRACT_ALL            = NO
47EXTRACT_PRIVATE        = NO
48EXTRACT_STATIC         = YES
49EXTRACT_LOCAL_CLASSES  = YES
50EXTRACT_LOCAL_METHODS  = NO
51HIDE_UNDOC_MEMBERS     = NO
52HIDE_UNDOC_CLASSES     = YES
53HIDE_FRIEND_COMPOUNDS  = YES
54HIDE_IN_BODY_DOCS      = NO
55INTERNAL_DOCS          = NO
56CASE_SENSE_NAMES       = YES
57HIDE_SCOPE_NAMES       = NO
58SHOW_INCLUDE_FILES     = YES
59INLINE_INFO            = YES
60SORT_MEMBER_DOCS       = YES
61SORT_BRIEF_DOCS        = NO
62SORT_BY_SCOPE_NAME     = NO
63GENERATE_TODOLIST      = NO
64GENERATE_TESTLIST      = NO
65GENERATE_BUGLIST       = NO
66GENERATE_DEPRECATEDLIST= NO
67ENABLED_SECTIONS       =
68MAX_INITIALIZER_LINES  = 30
69SHOW_USED_FILES        = YES
70SHOW_DIRECTORIES       = NO
71FILE_VERSION_FILTER    =
72#---------------------------------------------------------------------------
73# configuration options related to warning and progress messages
74#---------------------------------------------------------------------------
75QUIET                  = NO
76WARNINGS               = YES
77WARN_IF_UNDOCUMENTED   = YES
78WARN_IF_DOC_ERROR      = YES
79WARN_NO_PARAMDOC       = YES
80WARN_FORMAT            = "$file:$line: $text"
81WARN_LOGFILE           = doxygen.log
82#---------------------------------------------------------------------------
83# configuration options related to the input files
84#---------------------------------------------------------------------------
85INPUT                  = src/3rdparty/kdelibs/phonon
86FILE_PATTERNS          = *.cpp \
87                         *.h \
88                         *.dox
89RECURSIVE              = NO
90EXCLUDE                =
91EXCLUDE_SYMLINKS       = NO
92EXCLUDE_PATTERNS       =
93EXAMPLE_PATH           =
94EXAMPLE_PATTERNS       = *
95EXAMPLE_RECURSIVE      = NO
96IMAGE_PATH             =
97INPUT_FILTER           =
98FILTER_PATTERNS        =
99FILTER_SOURCE_FILES    = NO
100#---------------------------------------------------------------------------
101# configuration options related to source browsing
102#---------------------------------------------------------------------------
103SOURCE_BROWSER         = NO
104INLINE_SOURCES         = NO
105STRIP_CODE_COMMENTS    = YES
106REFERENCED_BY_RELATION = YES
107REFERENCES_RELATION    = YES
108REFERENCES_LINK_SOURCE = YES
109USE_HTAGS              = NO
110VERBATIM_HEADERS       = NO
111#---------------------------------------------------------------------------
112# configuration options related to the alphabetical class index
113#---------------------------------------------------------------------------
114ALPHABETICAL_INDEX     = NO
115COLS_IN_ALPHA_INDEX    = 5
116IGNORE_PREFIX          =
117#---------------------------------------------------------------------------
118# configuration options related to the HTML output
119#---------------------------------------------------------------------------
120GENERATE_HTML          = YES
121HTML_OUTPUT            = html-phonon
122HTML_FILE_EXTENSION    = .html
123HTML_HEADER            = tools/doxygen/config/header.html
124HTML_FOOTER            = tools/doxygen/config/footer.html
125HTML_STYLESHEET        = tools/doxygen/config/phonon.css
126HTML_ALIGN_MEMBERS     = NO
127GENERATE_HTMLHELP      = NO
128CHM_FILE               =
129HHC_LOCATION           =
130GENERATE_CHI           = NO
131BINARY_TOC             = NO
132TOC_EXPAND             = NO
133DISABLE_INDEX          = YES
134ENUM_VALUES_PER_LINE   = 4
135GENERATE_TREEVIEW      = NO
136TREEVIEW_WIDTH         = 250
137#---------------------------------------------------------------------------
138# configuration options related to the LaTeX output
139#---------------------------------------------------------------------------
140GENERATE_LATEX         = NO
141#---------------------------------------------------------------------------
142# configuration options related to the RTF output
143#---------------------------------------------------------------------------
144GENERATE_RTF           = NO
145#---------------------------------------------------------------------------
146# configuration options related to the man page output
147#---------------------------------------------------------------------------
148GENERATE_MAN           = NO
149#---------------------------------------------------------------------------
150# configuration options related to the XML output
151#---------------------------------------------------------------------------
152GENERATE_XML           = NO
153XML_OUTPUT             = xml
154XML_SCHEMA             =
155XML_DTD                =
156XML_PROGRAMLISTING     = NO
157#---------------------------------------------------------------------------
158# configuration options for the AutoGen Definitions output
159#---------------------------------------------------------------------------
160GENERATE_AUTOGEN_DEF   = NO
161#---------------------------------------------------------------------------
162# configuration options related to the Perl module output
163#---------------------------------------------------------------------------
164GENERATE_PERLMOD       = NO
165#---------------------------------------------------------------------------
166# Configuration options related to the preprocessor
167#---------------------------------------------------------------------------
168ENABLE_PREPROCESSING   = YES
169MACRO_EXPANSION        = NO
170EXPAND_ONLY_PREDEF     = NO
171SEARCH_INCLUDES        = YES
172INCLUDE_PATH           =
173INCLUDE_FILE_PATTERNS  =
174PREDEFINED             =
175EXPAND_AS_DEFINED      =
176SKIP_FUNCTION_MACROS   = YES
177#---------------------------------------------------------------------------
178# Configuration::additions related to external references
179#---------------------------------------------------------------------------
180TAGFILES               = doc/indexes/qt.tags
181GENERATE_TAGFILE       = doc/indexes/phonon.tags
182ALLEXTERNALS           = NO
183EXTERNAL_GROUPS        = YES
184PERL_PATH              = /usr/bin/perl
185#---------------------------------------------------------------------------
186# Configuration options related to the dot tool
187#---------------------------------------------------------------------------
188CLASS_DIAGRAMS         = NO
189#---------------------------------------------------------------------------
190# Configuration::additions related to the search engine
191#---------------------------------------------------------------------------
192SEARCHENGINE           = NO
193
194
195### KDE Settings
196ALIASES = \
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
Note: See TracBrowser for help on using the repository browser.