summaryrefslogtreecommitdiffstats
path: root/src/multimedia/doc/src
Commit message (Collapse)AuthorAgeFilesLines
* Doc: Fix multiple documentation issuesv5.13.0-beta3Topi Reinio2019-04-162-7/+24
| | | | | | | | | | | | | | | | | | | | | | | | - GstTools has some (internal) documentation, but was causing a number of warnings with QDoc's clang parser - exclude it from the documentation build. - Remove direct links from example documentation to individual example files; they no longer work. - Fix navigation for QML types; The main QML types pages did not list types for QtAudioEngiine. - Use \QtMinorVersion macro to make the documented import versions follow the minor Qt version. - Fix \since usage to be consistent throughout. - Fix linking issues for QML properties/methods - Minor language fixes Change-Id: I735cd13fa6dedd6bf06d6b6ef50ce2e0d69a545b Reviewed-by: VaL Doroshchuk <valentyn.doroshchuk@qt.io>
* Merge remote-tracking branch 'origin/5.12' into 5.13Qt Forward Merge Bot2019-03-022-4/+4
|\ | | | | | | Change-Id: Ia2f6f90c44bb360810124bcfab558661a2644880
| * Doc: Fix documented QtMultimedia importKai Koehne2019-02-262-4/+4
| | | | | | | | | | | | | | | | Since change 871a097d0c6e8203f82 QtMultimedia is registered with the latest Qt minor version, but the documentation wasn't updated yet. Change-Id: I58eb629c5a2851f83231891b2e219210d79c862c Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* | QML: Make QtAudioEngine import available under 1.QT_MINOR_VERSIONVaL Doroshchuk2019-02-262-7/+7
|/ | | | | | | | | | Made the QtAudioEngine import always available under the latest Qt minor version import QtAudioEngine 1.13 for 5.13 Task-number: QTBUG-74031 Change-Id: I14f602a5c59a6a6906aeeda8644e64dae36312e3 Reviewed-by: Kai Koehne <kai.koehne@qt.io>
* Doc: Move the literal codeblocks to snippet filesVenugopal Shivashankar2018-06-211-0/+10
| | | | | Change-Id: Icd9dff16b807d0bc7143a3d41f9799432035fa54 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Document licensesKai Koehne2018-01-181-0/+9
| | | | | Change-Id: I827a8de356f42217a64191a467fa850e3eb6f4ef Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Fix outdated FDL license headerKai Koehne2017-10-1815-45/+45
| | | | | Change-Id: I9cd7043058352ba2aeded74f86d863fca29bd37d Reviewed-by: Jani Heikkinen <jani.heikkinen@qt.io>
* doc: add platform specific notes for iOSRichard Moe Gustavsen2017-02-142-0/+44
| | | | | Change-Id: I5635f4d5ec4b86a3e8be1e74b58b46359ac17df4 Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* Remove Blackberry specific code pathsLars Knoll2016-11-142-87/+0
| | | | | Change-Id: I187085984eb1b25d7f3de163dc05122df1259720 Reviewed-by: Rafael Roquetto <rafael.roquetto@kdab.com>
* Bump QML module version in documentationYoann Lopes2016-09-263-4/+4
| | | | | Change-Id: I2c3574e2a5cf46ecc9719111b5293b67583d006c Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* Fix QML module version in documentationYoann Lopes2016-09-223-4/+4
| | | | | | | Upated to 5.7 from 5.6. Change-Id: Ife0bc905aa81a8e776c5fc3eeafbc5706e5352d3 Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* Doc: Change instances of 'OS X' to 'macOS'Topi Reinio2016-08-151-1/+1
| | | | | | | | | | As of version 10.12 (Sierra), the name of Apple's desktop operating system will be macOS. Change all occurrences where the platform is discussed to use the macro \macos (defined in the documentation configuration in qtbase). Change-Id: I1ba3b1e3c11870523516d3a13790d40dd0803aad Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Purge sRGB chunks from PNGs in documentation.Edward Welbourne2016-03-223-0/+0
| | | | | | | | Subjects each *.png file that matched grep -law "sRGB" to: pngcrush -ow -brute -rem allb -reduce -force Change-Id: I2ac34243ebe39c93860c5ac595c2f1eca4322eb8 Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
* Update version number in QML plugins.v5.6.0Yoann Lopes2016-02-254-7/+7
| | | | | | | | | Also removes unnecessary references of that import version in the documentation and snippets. The import version is always displayed at the top of every doc page anyway. Change-Id: Ifbf4666e0bc333c51f51104a5720b988e8c04d0b Reviewed-by: Christian Stromme <christian.stromme@theqtcompany.com>
* Doc: Fix documentation warningsTopi Reinio2016-01-083-24/+18
| | | | | | | | | | - Fix incorrect paths passed to \example command - Fix resulting linking issues - Fix examplesinstallpath in .qdocconf - Remove unnecessary group definition Change-Id: I72a437ac6d297f3c63d4f29a0e3110971d1e330f Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
* Doc: Move all doc artifacts under one projectVenugopal Shivashankar2015-12-072-5/+31
| | | | | | | | | Although the Qt Multimedia module has two submodules, a single project is sufficient to document these submodules, avoiding unnecessary maintenance overhead. Change-Id: I8fab48241b5c9aba35890a8aaa28ce7154f78c45 Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
* Doc: Exclude outdated content using \omit commandVenugopal Shivashankar2015-11-251-3/+2
| | | | | | Change-Id: Ifb30e398b57550788dab6955e3eac80949d47248 Reviewed-by: Yoann Lopes <yoann.lopes@theqtcompany.com> Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
* Merge remote-tracking branch 'origin/5.5' into 5.6Yoann Lopes2015-08-245-20/+13
|\ | | | | | | | | | | | | Conflicts: src/imports/multimedia/qdeclarativeaudio.cpp Change-Id: I57c6252b084e4ed796f6f308b2e0c717d0f59b13
| * Fix qdoc warnings.Yoann Lopes2015-08-111-3/+9
| | | | | | | | | | Change-Id: Ie351f33f88270186b7df0f9cd671fa4e31624231 Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
| * Doc: update qml module version to 5.5.Yoann Lopes2015-08-115-17/+4
| | | | | | | | | | | | | | | | | | And remove import statements from snippets. Change-Id: I109beabd445186f96f0750b6f23fb623c125181e Task-number: QTBUG-47620 Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com> Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* | Added new playlist QML type.Loïc Molinari2015-08-101-0/+6
|/ | | | | Change-Id: I0788cc9719f427457ad0be9c9a5bfda00451a0c4 Reviewed-by: Yoann Lopes <yoann.lopes@theqtcompany.com>
* Doc: replace Mac OS X with OS XNico Vertriest2015-07-151-1/+1
| | | | | | | Task-number: QTBUG-40759 Change-Id: I11b3aa74d35064371cbbbeba660114e086b16aea Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Doc: Added a link to the wiki with plugin info.Venugopal Shivashankar2015-05-131-0/+5
| | | | | | | | | | | The wiki summarizes each platform plugin and the supported features. Change-Id: Id7707306880d7e0612e73b879fc48201e0a97417 Task-number: QTBUG-30381 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> Reviewed-by: Yoann Lopes <yoann.lopes@theqtcompany.com> Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Merge remote-tracking branch 'origin/5.4' into devFrederik Gladhorn2015-02-131-1/+1
|\ | | | | | | Change-Id: I5575a4ba13212c9bfe73a3de3ef17c6528beafc3
| * Fix some typosSergio Ahumada2015-02-111-1/+1
| | | | | | | | | | Change-Id: Iaf8f50741d3103480668b4a654a202d8a363bc45 Reviewed-by: Yoann Lopes <yoann.lopes@theqtcompany.com>
* | Update copyright headersAntti Kokko2015-02-1215-89/+89
|/ | | | | | | | | Qt copyrights are now in The Qt Company, so we could update the source code headers accordingly. In the same go we should also fix the links to point to qt.io. Change-Id: I1c6faa4f59f8eca54f01ef20941fa60161dd7872 Reviewed-by: Yoann Lopes <yoann.lopes@theqtcompany.com>
* New camera selection API in QML.Yoann Lopes2014-07-174-5/+64
| | | | | | | | | | | | Also added a new QtMultimedia global object which makes it possible to retrieve the list of available cameras. It can be extended with new utility functions in the future. Includes documentation, example and auto tests. Task-number: QTBUG-23770 Change-Id: Ifea076329c3582ea99246ee1131853344a7b773f Reviewed-by: Christian Stromme <christian.stromme@digia.com>
* Doc: link errorsNico Vertriest2014-07-012-2/+2
| | | | | | Task-number: QTBUG-34749 Change-Id: I1d107a8700e03ac550fd6611d80a985a36558b22 Reviewed-by: Martin Smith <martin.smith@digia.com>
* Doc: Remove comment about preliminary API for Qt 5.0Topi Reinio2014-06-051-7/+3
| | | | | | Task-number: QTBUG-39195 Change-Id: I193321a29d06760e4ad5aa2eaca99d98b2e1f65a Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* New QCameraInfo class.Yoann Lopes2014-02-281-1/+10
| | | | | | | | | | | | | | | | | | | | The class allows to get the list of available cameras on the system as well as getting some static information about them such as their unique ID, display name, physical position and sensor orientation. This makes QCamera::availableDevices() and QCamera::deviceDescription() obsolete. This patch contains the API, documentation and auto-tests but not the actual implementation by each backend (except for retrieving the default camera device). [ChangeLog][QtMultimedia] Added new QCameraInfo class [ChangeLog][QtMultimedia] QCamera: availableDevices() and deviceDescription() are deprecated, use QCameraInfo instead Change-Id: I64fd65729ab26a789468979ed5444ee90bb82cd0 Reviewed-by: Christian Stromme <christian.stromme@digia.com>
* whitespace fixesOswald Buddenhagen2014-01-301-25/+25
| | | | | | | | remove trailing spaces & expand tabs. Change-Id: I05ef110abed90f13b47752760ffb4567a11a6a5e Reviewed-by: Yoann Lopes <yoann.lopes@digia.com> Reviewed-by: Tony Sarajärvi <tony.sarajarvi@digia.com>
* BlackBerry: Changed documentationBernd Weimer2014-01-132-2/+2
| | | | | | | Changed platform notes title to be able to reference it from elsewhere. Change-Id: I0edcebc6aa04e7a063cbe8b386ca8b38e0ae22a9 Reviewed-by: Thomas McGuire <thomas.mcguire@kdab.com>
* Fix some typos in documentation.Jeff Tranter2014-01-072-2/+2
| | | | | | | | Fix some spelling and grammatical errors in comments that show up in Qt documentation. No changes to code. Change-Id: Ieb7be17bd1d50751f00620f7ac28d09355856ac0 Reviewed-by: Yoann Lopes <yoann.lopes@digia.com> Reviewed-by: Sze Howe Koh <szehowe.koh@gmail.com>
* 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: 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: 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: Adding Qt Multimedia Widgets documentation.Jerome Pasion2013-02-261-0/+2
| | | | | | | | | | | -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-1914-26/+29
|\ | | | | | | | | | | | | | | | | | | 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 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>
| * 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-1013-13/+13
| | | | | | | | | | | | Change-Id: Ia8c1c38aba1544603fada8c414cc856f365fd15b Reviewed-by: Akseli Salovaara <akseli.salovaara@digia.com> Reviewed-by: Sergio Ahumada <sergio.ahumada@digia.com>
generated by cgit v1.2.3 (git 2.25.1) at 2024-05-14 07:09:46 +0000