-added instructions on how to run the example
(using \include to insert a section from qtbase/doc/global/)
-updated copyright year
-removed links to Qt 4 API
-rearranged some of the sections
-created links from the example pages to Qt Multimedia
-fixed QDoc warnings related to the example pages
Task-number: QTBUG-33597
Change-Id: Id45ce5cbd40dbfa384abd7260a316f6f6837c186
Reviewed-by: Yoann Lopes <yoann.lopes@digia.com>
Reviewed-by: Sze Howe Koh <szehowe.koh@gmail.com>
The correct paths are relative to:
- <reporoot>/examples/<module>, or
- <reporoot>/src/<module>
Removing the module specifier fixes these links/quotes.
Change-Id: I6be4f28c44bd26361b60a394158b0e6cc46b1ec0
Reviewed-by: Laszlo Papp <lpapp@kde.org>
Reviewed-by: Yoann Lopes <yoann.lopes@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
qdocconf files for both Qt Multimedia and Qt Multimedia Widgets already
define the correct example path. This change fixes also the example
documentation to use the correct path, as well as the link to examples
in Multimedia Overview.
Change-Id: I72d75027ee18f6398eb76dc40bcc3d122541b1c9
Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
- Fixed \snippet paths
- Minor language edits
- Removed unnecessary multiple page commands in a single comment
block. For example, \fn and \qmlsignal in a single comment block
is not allowed. Such instances must be documented in separate
comment blocks.
Change-Id: I65f4518499e2600c4e1807356d4116c575e48c19
Reviewed-by: Andy Nichols <andy.nichols@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
QDoc parses the \input command relative to the sourcedirs
and not exampledirs. So I had to move the qdocinc file and
the corresponding image to the sourcedirs.
Task-number: QTBUG-28727
Change-Id: Ie064f0b79ab8ffcb0587b43ff4508f5865a321a9
Reviewed-by: Martin Smith <martin.smith@digia.com>
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
Reviewed-by: Sergio Ahumada <sergio.ahumada@digia.com>
Also:
- Grouped the example docs under one group. i.e. multimedia-examples
- Moved the \group page here from the qtdoc repo
- Moved the snippets directory under doc from doc/src
Change-Id: I28fb81cf910e58101cd601fb4c440b59b0b0366d
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
