summaryrefslogtreecommitdiffstats
path: root/src/multimedia/doc
Commit message (Collapse)AuthorAgeFilesLines
...
* Doc: Fixed missing links to Qt Audio EngineJerome Pasion2013-10-083-6/+6
| | | | | | | The title changed from Positional Audio to Qt Audio Engine. Change-Id: Ie9901c7bc6c394c1c429a16a8a1b1c18b1a87f46 Reviewed-by: Martin Smith <martin.smith@digia.com>
* Doc: Various fixes to Qt Audio Engine documentationJerome Pasion2013-10-032-46/+37
| | | | | | | | | | | -fixed \since to "\since 5.0" (Qt version 5.0) -made a \qmlmodule page so the list of related classes are automatically listed -made changes in the Qt Multimedia documentation to link to the Qt Audio Engine documentation Change-Id: Ibdd3da02871648988a73172934e684840c4ce0ae Reviewed-by: Yoann Lopes <yoann.lopes@digia.com>
* Doc: Removing version number from the QDoc comments.Jerome Pasion2013-10-021-4/+4
| | | | | | | | | | The version is not needed anymore and QDoc handles them as a different module, causing errors. Task-number: QTBUG-32172 Change-Id: I55054a6c7bce9e001ef03cce944b03375c851d15 Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Updated usage of \qmlmodule and \inqmlmodule.Jerome Pasion2013-10-021-1/+1
| | | | | | | | | | -\qmlmodule denotes the import statement "QtMultimedia 5.0" -\inqmlmodule shouldn't have the version number and this commits removes it because it is confusing. Task-number: QTBUG-32172 Change-Id: I76f58ddd5ea2d5ae51eaae83a8408fd67611838a Reviewed-by: Martin Smith <martin.smith@digia.com>
* Doc: Renamed HTML file for "Qt Multimedia on Windows" page.Jerome Pasion2013-08-121-1/+1
| | | | | | | | Conflicts with the platform page for Windows in qt5/doc Task-number: QTBUG-32580 Change-Id: Ibcf51c5dcd93ac388fa799644004c51aa88fe93d Reviewed-by: Martin Smith <martin.smith@digia.com>
* Doc: Setting \qtvariable values in module pages.Jerome Pasion2013-08-021-0/+1
| | | | | | | \qtvariable is the QT variable in .pro files. Change-Id: Ib2e78579bbc67346b6c3431d03e01a4858439ac4 Reviewed-by: Martin Smith <martin.smith@digia.com>
* Doc: Setting navigation variables for Multimedia and Multimedia WidgetsJerome Pasion2013-06-261-0/+4
| | | | | | | | -for navigation bar Change-Id: I2d60e0145952c99afb6b103d0188ce846c192634 Reviewed-by: Yoann Lopes <yoann.lopes@digia.com> Reviewed-by: Martin Smith <martin.smith@digia.com>
* Doc: Fix some broken links and quote pathsSze Howe Koh2013-06-131-3/+3
| | | | | | | | | | | | | 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>
* Doc: Add Qt Multimedia platform notes for Windowsv5.1.0-rc1Topi Reinio2013-06-042-0/+58
| | | | | | | | | | | | | Add a page with details about Qt Multimedia backends on Windows, and link to it from the module index page. Initially, cover the status of camera backend in WMF and DirectShow plugins. Task-number: QTBUG-29552 Change-Id: I53e5901e2d621c4bbc96a61d5dbb249b4debb8d4 Reviewed-by: Yoann Lopes <yoann.lopes@digia.com> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@digia.com>
* Doc: Adding import statement for in Qt Multimedia QML TypesJerome Pasion2013-06-031-4/+7
| | | | | | | Change-Id: I17e108c5d8524fe428ab8f0ca14130cd4bb78d2d Reviewed-by: Liang Qi <liang.qi@digia.com> Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com> Reviewed-by: Martin Smith <martin.smith@digia.com>
* Doc: Removed multimedia overview from "technology-apis" group.Jerome Pasion2013-05-241-2/+0
| | | | | | | The group in qtdoc was removed. Change-Id: Ifa8b67421f4eb7b117ee947b186c85bfdd5a8c5d Reviewed-by: Geir Vattekar <geir.vattekar@digia.com>
* Doc: Define example install paths in .qdocconfTopi Reinio2013-05-031-0/+3
| | | | | | | | | QDoc needs to know the directory under which the examples are installed in QT_INSTALL_EXAMPLES. Without them, example manifest files may contain invalid paths. Change-Id: I3d27517e41e3b1deb7643ca1a40f3905c0e5cc1a Reviewed-by: Martin Smith <martin.smith@digia.com>
* Doc: Fix example paths referred in documentationTopi Reinio2013-04-301-15/+15
| | | | | | | | | | | 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>
* Doc: Several cosmetic doc fixes.Jerome Pasion2013-04-233-50/+65
| | | | | | | | | | -changed title of "Qt Multimedia Overview" to "Multimedia". It follows the other topic titles from qtdoc. -fixed column widths of paragraphs Change-Id: I8a12d1d9a2a9c3ca184d69ebe464c80721a117f7 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com> Reviewed-by: Geir Vattekar <geir.vattekar@digia.com>
* Doc: Fix module names in .qdocconf for Qt Multimedia & WidgetsTopi Reinio2013-04-191-15/+15
| | | | | | | | | | | | | This change fixes QCH documentation title for Qt Multimedia Widgets. Also, the project names are changed to use CamelCase - this is required as qdoc will generate visible output (tags in example manifest files) based on those names. Also, removes documentation topic for QML types from Qt Multimedia Widgets as it doesn't have any. Change-Id: Ic5f3b7a3094a1012f3c356f0195a8eb40d9d9e35 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Adding Qt Multimedia Widgets documentation.Jerome Pasion2013-02-262-3/+5
| | | | | | | | | | | -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>
* Merge remote-tracking branch 'origin/stable' into devFrederik Gladhorn2013-02-1922-51/+60
|\ | | | | | | | | | | | | | | | | | | Conflicts: src/multimedia/doc/qtmultimedia.qdocconf src/plugins/blackberry/mediaplayer/bbmetadata.cpp src/plugins/blackberry/mediaplayer/bbmetadata.h tests/auto/unit/qpaintervideosurface/tst_qpaintervideosurface.cpp Change-Id: I447c297ea15a94d1d2feb0fb5f9edac8c5d4505a
| * Doc: Fix faulty snippet in Video Overview pageTopi Reinio2013-02-191-1/+5
| | | | | | | | | | | | | | | | | | | | 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>
| * fix doc page urlsOswald Buddenhagen2013-02-061-1/+1
| | | | | | | | | | | | | | they are versioned nowadays Change-Id: I5c2ca367b8e63523811c03595cf8a7e326e8a662 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
| * substitute fixed version numbers in qdocconf files with variablesOswald Buddenhagen2013-02-061-2/+2
| | | | | | | | | | Change-Id: I20bd702b481d82903f5f4a42e74a8fb8ad4e71dc Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
| * Add a simple accessor to the video provider snippetLaszlo Papp2013-02-061-1/+3
| | | | | | | | | | | | | | | | Task-number: QTBUG-29383 Change-Id: I744fb997dae6ad1f9b8075791ad463c8fe23a96d Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
| * Merge branch 'release' into stableSergio Ahumada2013-01-291-2/+2
| |\ | | | | | | | | | Change-Id: If07e76a0f2f46d6dc50a41441324f02393e17d01
| | * Doc: Add QML Types to table of contents in AssistantJerome Pasion2013-01-281-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
| | * Doc: Fixed "QML Types" listing C++ classes.Jerome Pasion2013-01-221-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | Removed "class" from the "selectors" qdocconf variable Task-number: QTBUG-29242 Change-Id: I1d6c264a6a4277dff27bffcd39d9841363241f7d Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com> Reviewed-by: Geir Vattekar <geir.vattekar@digia.com>
| | * Doc: Fixed random QDoc warningsVenugopal Shivashankar2013-01-172-8/+11
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | - 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 51334d299520118bbbc077696ca589f972a2f2ea)
| | * doc: Fix namespace version to 5.0.1 for qhp documentationSergio Ahumada2013-01-121-1/+1
| | | | | | | | | | | | | | | Change-Id: Ie2d0aeff6d8b63ae9d18896320557d28cc9adb68 Reviewed-by: hjk <qthjk@ovi.com>
| * | Doc: Fix module name formatSze Howe Koh2013-01-293-5/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Follow the conventions at http://qt-project.org/wiki/Spelling_Module_Names_in_Qt_Documentation QtMultimedia -> Qt Multimedia (Also, QtMultimediaKit has been merged into Qt Multimedia in Qt 5) Change-Id: I3c23435d5eceb946ea320756b835da937726db24 Reviewed-by: Laszlo Papp <lpapp@kde.org> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
| * | QAudioInput/Output documentation: Fix slot naming in snippetsTopi Reinio2013-01-251-12/+12
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
| * | Doc: Fixed random QDoc warningsVenugopal Shivashankar2013-01-152-8/+11
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | - 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>
| * | Update copyright year in Digia's license headersSergio Ahumada2013-01-1020-20/+20
| |/ | | | | | | | | | | Change-Id: Ia8c1c38aba1544603fada8c414cc856f365fd15b Reviewed-by: Akseli Salovaara <akseli.salovaara@digia.com> Reviewed-by: Sergio Ahumada <sergio.ahumada@digia.com>
* | Blackberry: Extend platform-specific documentationTobias Koenig2013-02-191-1/+9
| | | | | | | | | | | | | | | | 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>
* | Bump Qt version to 5.1.0Frederik Gladhorn2013-01-151-2/+2
|/ | | | | Change-Id: I68f5c34fe14860c40537a23f28e741f0ac1eef1e Reviewed-by: David Faure (KDE) <faure@kde.org>
* Doc: Moved the qdocinc and image to the sourcedirsVenugopal Shivashankar2013-01-022-0/+43
| | | | | | | | | | | | 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>
* Bump Qt version to 5.0.1Sergio Ahumada2012-12-251-1/+1
| | | | | Change-Id: Ic45b749ceea86263281b5c23509bf301fa334e5f Reviewed-by: Jonas Rabbe <jonas.rabbe@gmail.com>
* Doc: Fixed broken links to the Multimedia examplesVenugopal Shivashankar2012-12-141-12/+15
| | | | | | | | | | | - 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>
* Doc: Updated the \example and \snippet pathsv5.0.0-rc2Venugopal Shivashankar2012-12-1215-33/+54
| | | | | | | | | | 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>
* Doc: Added missing images and made some language editsVenugopal Shivashankar2012-11-301-2/+1
| | | | | Change-Id: I9544121601c2c4099927e0e23550c3ab32bbfda9 Reviewed-by: Eskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@digia.com>
* Doc: cleanup multimedia overviewAndy Nichols2012-11-281-3/+10
| | | | | | | Added an introduction, and fix some formatting. Change-Id: Ic23416cf1113895a1895a53f310530a83a9013d3 Reviewed-by: Paul Olav Tvete <paul.tvete@digia.com>
* Doc: Cleanup diagram placeholder in Camera OverviewAndy Nichols2012-11-271-4/+0
| | | | | | | | | 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>
* Doc: Polish the description of changes to the Qt Multimedia moduleSze Howe Koh2012-11-211-62/+46
| | | | | | | | | | | | | | | | - 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>
* Merge branch 'newdocs'Eskil Abrahamsen Blomfeldt2012-11-205-244/+23
|\ | | | | | | Change-Id: Ia45daee9b5089c01300cf27484296809dd87302f
| * Doc: Removed extra qdocconf files.Jerome Pasion2012-11-075-243/+23
| | | | | | | | | | | | | | | | The variables and macros are in qtbase/doc/global. Corrected QHP variables. Change-Id: I4b5816d0d0ce7a228ed27944fb9471f390f7334d Reviewed-by: Martin Smith <martin.smith@digia.com>
| * Merge branch 'master' of ssh://codereview.qt-project.org/qt/qtmultimedia ↵Jerome Pasion2012-11-021-5/+0
| |\ | | | | | | | | | | | | | | | into newdocs Change-Id: Idb607da32f80784d94556443be6740c6d7223411
| * | doc: update documentation project name to match module nameTor Arne Vestbø2012-10-121-2/+1
| | | | | | | | | | | | | | | | | | | | | | | | 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>
* | | Blackberry: Add a page with platform-specific documentationThomas McGuire2012-11-072-0/+83
| | | | | | | | | | | | | | | | | | | | | Change-Id: Ic03c59523648ee25c419ec5d80122da9a717aa2d Reviewed-by: Bernd Weimer <bweimer@rim.com> Reviewed-by: Mitch Curtis <mitch.curtis@digia.com> Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
* | | Rename namespace QtMultimedia -> QMultimediaSze Howe Koh2012-11-061-3/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* | | Rename namespace QtMultimedia::MetaData -> QMediaMetaDataSze Howe Koh2012-11-061-2/+2
| |/ |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Main code, examples, tests and docs updated. Method: 1. Remove unused forward-declarations, "class QMediaMetaData" 2. Mass find+replace "QtMultimedia::MetaData" -> "QMediaMetaData" 3. Un-nest from the QtMultimedia namespace in qtmedianamespace.h For consistency (with minimal disruption), namespaces with a "Qt" prefix will be renamed. Also, Qt guidelines don't include nested namespaces (http://lists.qt-project.org/pipermail/development/2012-October/006756.html) Part of the Header Consistency Project (http://lists.qt-project.org/pipermail/development/2012-October/007570.html) Change-Id: I40e59c1cf58c1792725e735e9285c51bc5f226b1 Reviewed-by: Lars Knoll <lars.knoll@digia.com> Reviewed-by: Stephen Kelly <stephen.kelly@kdab.com>
* | Doc: Removed dependency on qtmultimedia.cssVenugopal Shivashankar2012-10-191-5/+0
|/ | | | | | | | 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>
* Update docs after modularization of docsTor Arne Vestbø2012-10-112-48/+3
| | | | | | | | | | | 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>
* Doc: Added Qt Multimedia to 'qmlmodules' groupJerome Pasion2012-10-031-1/+2
| | | | | | | | | -'qmlmodules' contains Qt's QML API -made brief description consistent with other QML API Change-Id: I30473048b06e2a4e13deb57c394a12c51a11693b Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
generated by cgit v1.2.3 (git 2.25.1) at 2024-05-04 18:49:51 +0000