-added landing page and module page
-linked to Qt Multimedia and Qt Widgets
-excluded multimediawidgets dir from the Qt Multimedia documentation
Task-number: QTBUG-29339
Change-Id: Iaa8dc4117505d5635b8cab97ed5c10e9c4a289e6
Reviewed-by: Lars Knoll <lars.knoll@digia.com>
Reviewed-by: Sze Howe Koh <szehowe.koh@gmail.com>
Reflect camera support in Blackberry-specific documentation page.
Change-Id: I5267a32b99aa88cd73f33fe045d67579442f9932
Reviewed-by: Bernd Weimer <bweimer@rim.com>
Reviewed-by: Thomas McGuire <thomas.mcguire@kdab.com>
This change modifies setVideoSurface() in the snippet code
to be a bit more robust.
Task-number: QTBUG-29383
Change-Id: I2c691f19fe8f0912c1287597045da3a5579d2108
Reviewed-by: Yoann Lopes <yoann.lopes@digia.com>
Replace 'headerfile' with 'qmlclass' in qdocconf file.
As a positive side-effect, QDoc will also add files for
'All members' for QML Types into .qhp as well.
Task-number: QTBUG-29226
Change-Id: I892f386cbd22bfbf7a04be5aecc800896e1090ec
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
Reviewed-by: Geir Vattekar <geir.vattekar@digia.com>
Having a code snippet use a slot (stateChanged) with a name
identical to a signal in QAudioInput / QAudioOutput classes causes
problems (incorrect links) in class documentation that refer to
the snippet code.
This change renames the slots according to standard Qt convention.
Same change is applied to example applications as well.
Task-number: QTBUG-26688
Change-Id: I0c6181240237d0c642b73fe18f3ddb5137b7f207
Reviewed-by: Dmytro Poplavskiy <dmytro.poplavskiy@gmail.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>
(cherry picked from commit 51334d2995)
- 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>
- Updated the example links to reflect the new directory
structure for the multimedia examples.
- Removed a broken link to audiodecoder example
as it doesn't have a qdoc page yet.
Change-Id: Ia1169eeb80b4e6b6f92cd070aecbe72ce696bb6a
Reviewed-by: Martin Smith <martin.smith@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@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>
Added an introduction, and fix some formatting.
Change-Id: Ic23416cf1113895a1895a53f310530a83a9013d3
Reviewed-by: Paul Olav Tvete <paul.tvete@digia.com>
The diagram still needs to be done, but is not necessary for the 5.0
release.
Task-number: QTBUG-28235
Change-Id: I1e8b4d731c00516408de89be81d4ecb8bde3d016
Reviewed-by: Paul Olav Tvete <paul.tvete@digia.com>
- Fix errors
- QtMultimediaKit is renamed to QMultimedia, not QtMultimedia
- It's not necessary to explicitly convert metadata keys into
strings -- Q_DECLARE_METADATA takes care of that
- The introduction of MediaPlayer and VideoOutput does not affect
existing code
- Follow module naming guidelines at
http://qt-project.org/wiki/Spelling_Module_Names_in_Qt_Documentation
- Shorten descriptions, improve flow
- Remove trivia
Change-Id: I3ab9bb2f8f33cbea52b5993f3060d929a7e39ef1
Reviewed-by: Eskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@digia.com>
The variables and macros are in qtbase/doc/global.
Corrected QHP variables.
Change-Id: I4b5816d0d0ce7a228ed27944fb9471f390f7334d
Reviewed-by: Martin Smith <martin.smith@digia.com>
Main code, examples, tests and docs updated. Method:
1. Mass find+replace "QtMultimedia::" -> "QMultimedia::"
2. Hand-modified declaration in qtmedianamespace.h/cpp
For consistency (with minimal disruption), namespaces with a "Qt" prefix
will be renamed.
Part of the Header Consistency Project
(http://lists.qt-project.org/pipermail/development/2012-October/007570.html)
Change-Id: I1fbc43a1aa91d996aa61869fcd8d05186bf7cf6d
Reviewed-by: Lars Knoll <lars.knoll@digia.com>
Reviewed-by: Stephen Kelly <stephen.kelly@kdab.com>
All module documentation must use the global HTML template and style
sheet in qtbase\doc\global.
Change-Id: Ia7db9373f2291052924f433223a128ef4c2c3df8
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Otherwise qdoc will fail to find the index file when looking for
qtbase/doc/qtmodulename/qtmodulename.index.
Change-Id: I116b09350f157a42df6dbdb9d3029f4917f59299
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
The global files now live in qtbase only, and are made available to the
other modules via the $QT_INSTALL_DOCS variable.
We now use QMAKE_DOCS to trigger doc generation instead of rolling our
own rules for qdoc.
Change-Id: I900029d71c305a1f269cddeeb0e05c524d933834
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
