/tools/doxygen/config/phonon.doxyfile

https://bitbucket.org/ultra_iter/qt-vtl · Unknown · 220 lines · 216 code · 4 blank · 0 comment · 0 complexity · c1ce9abb4a9097bedd8a46bb23ec1e4d MD5 · raw file

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