From 962e99534d8955ae6c3c3524c5005f518b4e01bc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tor=20Arne=20Vestb=C3=B8?= Date: Fri, 12 Oct 2012 16:03:35 +0200 Subject: doc: update documentation project name to match module name Otherwise qdoc will fail to find the index file when looking for qtbase/doc/qtmodulename/qtmodulename.index. Change-Id: I116b09350f157a42df6dbdb9d3029f4917f59299 Reviewed-by: Jerome Pasion --- src/multimedia/doc/qtmultimedia.qdocconf | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/src/multimedia/doc/qtmultimedia.qdocconf b/src/multimedia/doc/qtmultimedia.qdocconf index 44b0105a4..9ed3ee0b8 100644 --- a/src/multimedia/doc/qtmultimedia.qdocconf +++ b/src/multimedia/doc/qtmultimedia.qdocconf @@ -6,8 +6,7 @@ include(macros.qdocconf) include(qt-cpp-ignore.qdocconf) include(qt-defines.qdocconf) -# Name of the project. -project = Qt Multimedia +project = qtmultimedia description = Qt Multimedia Documentation # Directories in which to search for files to document and images. -- cgit v1.2.1 From e83d04557accc0277b8020d3538263edeaca6669 Mon Sep 17 00:00:00 2001 From: Jerome Pasion Date: Wed, 7 Nov 2012 14:02:40 +0100 Subject: Doc: Removed extra qdocconf files. The variables and macros are in qtbase/doc/global. Corrected QHP variables. Change-Id: I4b5816d0d0ce7a228ed27944fb9471f390f7334d Reviewed-by: Martin Smith --- src/multimedia/doc/compat.qdocconf | 30 --------- src/multimedia/doc/macros.qdocconf | 37 ----------- src/multimedia/doc/qt-cpp-ignore.qdocconf | 100 ------------------------------ src/multimedia/doc/qt-defines.qdocconf | 17 ----- src/multimedia/doc/qtmultimedia.qdocconf | 82 +++++++----------------- 5 files changed, 23 insertions(+), 243 deletions(-) delete mode 100644 src/multimedia/doc/compat.qdocconf delete mode 100644 src/multimedia/doc/macros.qdocconf delete mode 100644 src/multimedia/doc/qt-cpp-ignore.qdocconf delete mode 100644 src/multimedia/doc/qt-defines.qdocconf diff --git a/src/multimedia/doc/compat.qdocconf b/src/multimedia/doc/compat.qdocconf deleted file mode 100644 index 924db57a1..000000000 --- a/src/multimedia/doc/compat.qdocconf +++ /dev/null @@ -1,30 +0,0 @@ -alias.include = input - -macro.0 = "\\\\0" -macro.b = "\\\\b" -macro.n = "\\\\n" -macro.r = "\\\\r" -macro.i = "\\li" -macro.i11 = "\\li{1,1}" -macro.i12 = "\\li{1,2}" -macro.i13 = "\\li{1,3}" -macro.i14 = "\\li{1,4}" -macro.i15 = "\\li{1,5}" -macro.i16 = "\\li{1,6}" -macro.i17 = "\\li{1,7}" -macro.i18 = "\\li{1,8}" -macro.i19 = "\\li{1,9}" -macro.i21 = "\\li{2,1}" -macro.i31 = "\\li{3,1}" -macro.i41 = "\\li{4,1}" -macro.i51 = "\\li{5,1}" -macro.i61 = "\\li{6,1}" -macro.i71 = "\\li{7,1}" -macro.i81 = "\\li{8,1}" -macro.i91 = "\\li{9,1}" -macro.img = "\\image" -macro.endquote = "\\endquotation" -macro.relatesto = "\\relates" - -spurious = "Missing comma in .*" \ - "Missing pattern .*" diff --git a/src/multimedia/doc/macros.qdocconf b/src/multimedia/doc/macros.qdocconf deleted file mode 100644 index d8b96c0bf..000000000 --- a/src/multimedia/doc/macros.qdocconf +++ /dev/null @@ -1,37 +0,0 @@ -macro.aacute.HTML = "á" -macro.Aring.HTML = "Å" -macro.aring.HTML = "å" -macro.Auml.HTML = "Ä" -macro.author = "\\b{Author:}" -macro.br.HTML = "
" -macro.BR.HTML = "
" -macro.copyright.HTML = "©" -macro.eacute.HTML = "é" -macro.gui = "\\b" -macro.hr.HTML = "
" -macro.iacute.HTML = "í" -macro.key = "\\b" -macro.menu = "\\b" -macro.note = "\\b{Note:}" -macro.oslash.HTML = "ø" -macro.ouml.HTML = "ö" -macro.QA = "\\e{Qt Assistant}" -macro.QD = "\\e{Qt Designer}" -macro.QL = "\\e{Qt Linguist}" -macro.QQV = "\\e{Qt QML Viewer}" -macro.param = "\\e" -macro.raisedaster.HTML = "*" -macro.rarrow.HTML = "→" -macro.reg.HTML = "®" -macro.return = "Returns" -macro.starslash = "\\c{*/}" -macro.begincomment = "\\c{/*}" -macro.endcomment = "\\c{*/}" -macro.uuml.HTML = "ü" -macro.mdash.HTML = "—" - -macro.beginfloatleft.HTML = "
" -macro.beginfloatright.HTML = "
" -macro.endfloat.HTML = "
" -macro.clearfloat.HTML = "
" -macro.emptyspan.HTML = "" diff --git a/src/multimedia/doc/qt-cpp-ignore.qdocconf b/src/multimedia/doc/qt-cpp-ignore.qdocconf deleted file mode 100644 index b3a8602da..000000000 --- a/src/multimedia/doc/qt-cpp-ignore.qdocconf +++ /dev/null @@ -1,100 +0,0 @@ -Cpp.ignoretokens = QAXFACTORY_EXPORT \ - QDESIGNER_COMPONENTS_LIBRARY \ - QDESIGNER_EXTENSION_LIBRARY \ - QDESIGNER_SDK_LIBRARY \ - QDESIGNER_SHARED_LIBRARY \ - QDESIGNER_UILIB_LIBRARY \ - QM_EXPORT_CANVAS \ - QM_EXPORT_DNS \ - QM_EXPORT_DOM \ - QM_EXPORT_FTP \ - QM_EXPORT_HTTP \ - QM_EXPORT_ICONVIEW \ - QM_EXPORT_NETWORK \ - QM_EXPORT_OPENGL \ - QM_EXPORT_OPENVG \ - QM_EXPORT_SQL \ - QM_EXPORT_TABLE \ - QM_EXPORT_WORKSPACE \ - QM_EXPORT_XML \ - QT_ASCII_CAST_WARN \ - QT_ASCII_CAST_WARN_CONSTRUCTOR \ - QT_BEGIN_HEADER \ - QT_DESIGNER_STATIC \ - QT_END_HEADER \ - QT_FASTCALL \ - QT_WIDGET_PLUGIN_EXPORT \ - Q_COMPAT_EXPORT \ - Q_CORE_EXPORT \ - Q_CORE_EXPORT_INLINE \ - Q_EXPLICIT \ - Q_EXPORT \ - Q_EXPORT_CODECS_CN \ - Q_EXPORT_CODECS_JP \ - Q_EXPORT_CODECS_KR \ - Q_EXPORT_PLUGIN \ - Q_GFX_INLINE \ - Q_AUTOTEST_EXPORT \ - QM_AUTOTEST_EXPORT \ - Q_GUI_EXPORT \ - Q_GUI_EXPORT_INLINE \ - Q_GUI_EXPORT_STYLE_CDE \ - Q_GUI_EXPORT_STYLE_COMPACT \ - Q_GUI_EXPORT_STYLE_MAC \ - Q_GUI_EXPORT_STYLE_MOTIF \ - Q_GUI_EXPORT_STYLE_MOTIFPLUS \ - Q_GUI_EXPORT_STYLE_PLATINUM \ - Q_GUI_EXPORT_STYLE_POCKETPC \ - Q_GUI_EXPORT_STYLE_SGI \ - Q_GUI_EXPORT_STYLE_WINDOWS \ - Q_GUI_EXPORT_STYLE_WINDOWSXP \ - QHELP_EXPORT \ - Q_INLINE_TEMPLATE \ - Q_INTERNAL_WIN_NO_THROW \ - Q_NETWORK_EXPORT \ - Q_OPENGL_EXPORT \ - Q_OPENVG_EXPORT \ - Q_OUTOFLINE_TEMPLATE \ - Q_SQL_EXPORT \ - Q_SVG_EXPORT \ - Q_SCRIPT_EXPORT \ - Q_SCRIPTTOOLS_EXPORT \ - Q_TESTLIB_EXPORT \ - Q_TYPENAME \ - Q_XML_EXPORT \ - Q_XMLSTREAM_EXPORT \ - Q_XMLPATTERNS_EXPORT \ - QDBUS_EXPORT \ - Q_DBUS_EXPORT \ - QT_BEGIN_NAMESPACE \ - QT_BEGIN_INCLUDE_NAMESPACE \ - QT_END_NAMESPACE \ - QT_END_INCLUDE_NAMESPACE \ - PHONON_EXPORT \ - Q_DECLARATIVE_EXPORT \ - Q_GADGET \ - QWEBKIT_EXPORT \ - Q_INVOKABLE \ - Q_MULTIMEDIA_EXPORT -Cpp.ignoredirectives = Q_DECLARE_HANDLE \ - Q_DECLARE_INTERFACE \ - Q_DECLARE_METATYPE \ - Q_DECLARE_OPERATORS_FOR_FLAGS \ - Q_DECLARE_PRIVATE \ - Q_DECLARE_PUBLIC \ - Q_DECLARE_SHARED \ - Q_DECLARE_TR_FUNCTIONS \ - Q_DECLARE_TYPEINFO \ - Q_DISABLE_COPY \ - QT_FORWARD_DECLARE_CLASS \ - Q_DUMMY_COMPARISON_OPERATOR \ - Q_ENUMS \ - Q_FLAGS \ - Q_INTERFACES \ - __attribute__ \ - K_DECLARE_PRIVATE \ - PHONON_OBJECT \ - PHONON_HEIR \ - Q_PRIVATE_PROPERTY \ - Q_DECLARE_PRIVATE_D \ - Q_CLASSINFO diff --git a/src/multimedia/doc/qt-defines.qdocconf b/src/multimedia/doc/qt-defines.qdocconf deleted file mode 100644 index 50a355f04..000000000 --- a/src/multimedia/doc/qt-defines.qdocconf +++ /dev/null @@ -1,17 +0,0 @@ -defines = Q_QDOC \ - QT_.*_SUPPORT \ - QT_.*_LIB \ - QT_COMPAT \ - QT_KEYPAD_NAVIGATION \ - QT_NO_EGL \ - QT3_SUPPORT \ - Q_WS_.* \ - Q_OS_.* \ - Q_BYTE_ORDER \ - QT_DEPRECATED \ - Q_NO_USING_KEYWORD \ - __cplusplus - -versionsym = QT_VERSION_STR - -codeindent = 1 diff --git a/src/multimedia/doc/qtmultimedia.qdocconf b/src/multimedia/doc/qtmultimedia.qdocconf index 6f60049dc..bc5c0912d 100644 --- a/src/multimedia/doc/qtmultimedia.qdocconf +++ b/src/multimedia/doc/qtmultimedia.qdocconf @@ -1,35 +1,9 @@ -include($QT_INSTALL_DOCS/global/qt-html-templates-offline.qdocconf) include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf) -include(compat.qdocconf) -include(macros.qdocconf) -include(qt-cpp-ignore.qdocconf) -include(qt-defines.qdocconf) - -project = qtmultimedia -description = Qt Multimedia Documentation - -# Directories in which to search for files to document and images. -# By default set to the root directory of the project for sources -# and headers and qdoc will therefore generate output for each file. -# Images should be placed in /dic/images and examples in -# /examples. -# Paths are relative to the location of this file. - -exampledirs += .. \ - ../../../examples - -headerdirs += ../.. - -imagedirs += src/images \ - -sourcedirs += ../.. - -excludedirs += - -# The index file contains links to the Qt 5 documentation. -# Point to the any .index file to cross link to other projects -#indexes = $QT5DOC/doc/html/qt.index +project = qtmultimedia +description = Qt Multimedia Documentation +url = http://qt-project.org/doc/qtmultimedia +version = 5.0.0 # The following parameters are for creating a qhp file, the qhelpgenerator # program can convert the qhp file into a qch file which can be opened in @@ -39,41 +13,31 @@ excludedirs += # the name. Properties for this project are set using a qhp..property # format. qhp.projects = qtmultimedia - -# Sets the name of the output qhp file. qhp.qtmultimedia.file = qtmultimedia.qhp - -# Namespace for the output file. This namespace is used to distinguish between -# different documentation files in Creator/Assistant. -qhp.qtmultimedia.namespace = qtmultimedia.500 - -# Title for the package, will be the main title for the package in -# Assistant/Creator. -qhp.qtmultimedia.indexTitle = Qt Multimedia Documentation - -# Extra files to add to the output which are not linked to from anywhere -# using a qdoc \l command. -qhp.qtmultimedia.extraFiles = style/qtmultimedia.css - -# Only update the name of the project for the next variables. -qhp.qtmultimedia.virtualFolder = qdoc -qhp.qtmultimedia.subprojects = classes -qhp.qtmultimedia.subprojects.classes.title = Classes +qhp.qtmultimedia.namespace = org.qt-project.qtmultimedia.500 +qhp.qtmultimedia.indexTitle = Qt Multimedia +qhp.qtmultimedia.virtualFolder = qtmultimedia + +# For listing child nodes in Qt Creator or Assistant. +qhp.qtmultimedia.subprojects = classes qmltypes +qhp.qtmultimedia.subprojects.classes.title = C++ Classes +qhp.qtmultimedia.subprojects.classes.indexTitle = Qt Multimedia C++ Classes qhp.qtmultimedia.subprojects.classes.selectors = class fake:headerfile qhp.qtmultimedia.subprojects.classes.sortPages = true +qhp.qtmultimedia.subprojects.qmltypes.title = QML Types +qhp.qtmultimedia.subprojects.qmltypes.indexTitle = Qt Multimedia QML Types +qhp.qtmultimedia.subprojects.qmltypes.selectors = class fake:headerfile +qhp.qtmultimedia.subprojects.qmltypes.sortPages = true +exampledirs += .. \ + ../../../examples +headerdirs += ../.. -# Do NOT change the variables after this line unless you know what you are doing. - -outputformats = HTML - -examples.fileextensions = "*.cpp *.h *.js *.svg *.xml *.ui *.qml" -examples.imageextensions = "*.png *.jpeg *.jpg *.gif *.mng" -headers.fileextensions = "*.h *.ch *.h++ *.hh *.hpp *.hxx" -sources.fileextensions = "*.cpp *.qdoc *.mm *.qml" +imagedirs += src/images \ -HTML.nobreadcrumbs = "true" +sourcedirs += ../.. -HTML.templatedir = . +excludedirs += +depends += qtcore qtdoc qtquick qtqml -- cgit v1.2.1