Commit Graph

64 Commits

Author SHA1 Message Date
Sergio Ahumada
b6970e2e79 Doc: Fix some documentation warnings
- Can't link to 'QSlider'
- Can't link to 'QImage'

Change-Id: Ifa1a27ca5224959d6dbb4c0055a56114740469f0
Reviewed-by: Sze Howe Koh <szehowe.koh@gmail.com>
Reviewed-by: Jędrzej Nowacki <jedrzej.nowacki@digia.com>
2014-04-01 10:55:48 +02:00
Yoann Lopes
b28ee24628 New QCameraInfo class.
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>
2014-02-28 14:10:00 +01:00
Oswald Buddenhagen
5980bc41cf whitespace fixes
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>
2014-01-30 14:32:10 +01:00
Bernd Weimer
16aadf964d BlackBerry: Changed documentation
Changed platform notes title to be able to reference it from elsewhere.

Change-Id: I0edcebc6aa04e7a063cbe8b386ca8b38e0ae22a9
Reviewed-by: Thomas McGuire <thomas.mcguire@kdab.com>
2014-01-13 10:30:00 +01:00
Jeff Tranter
a0d39a2ab6 Fix some typos in documentation.
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>
2014-01-07 13:22:07 +01:00
Jerome Pasion
fb199a5045 Doc: Updated url variable in qdocconf files.
In 5.2, the HTML output is in a flatter structure and when they are
hosted in qt-project.org/doc, the documentation will be found at
http://qt-project.org/doc/qt-$QT_VER

The url variable is used by projects outside of Qt 5 which need
to link to Qt 5 documentation, such as Qt Creator.

Task-number: QTBUG-34584
Change-Id: I3971987490ef7c2f8060383ffc2e141558f827c9
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
2013-11-06 10:56:03 +01:00
Jerome Pasion
1598f79b17 Doc: Fixed missing links to Qt Audio Engine
The title changed from Positional Audio to Qt Audio Engine.

Change-Id: Ie9901c7bc6c394c1c429a16a8a1b1c18b1a87f46
Reviewed-by: Martin Smith <martin.smith@digia.com>
2013-10-08 12:27:52 +02:00
Jerome Pasion
3793b0653f Doc: Various fixes to Qt Audio Engine documentation
-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>
2013-10-03 10:54:17 +02:00
Jerome Pasion
43be5d9763 Doc: Removing version number from the QDoc comments.
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>
2013-10-02 12:56:28 +02:00
Jerome Pasion
40908fdb77 Doc: Updated usage of \qmlmodule and \inqmlmodule.
-\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>
2013-10-02 12:56:21 +02:00
Jerome Pasion
206cf434a2 Doc: Renamed HTML file for "Qt Multimedia on Windows" page.
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>
2013-08-12 13:50:46 +02:00
Jerome Pasion
ab29837c0e Doc: Setting \qtvariable values in module pages.
\qtvariable is the QT variable in .pro files.

Change-Id: Ib2e78579bbc67346b6c3431d03e01a4858439ac4
Reviewed-by: Martin Smith <martin.smith@digia.com>
2013-08-02 17:22:14 +02:00
Jerome Pasion
6d40540fce Doc: Setting navigation variables for Multimedia and Multimedia Widgets
-for navigation bar

Change-Id: I2d60e0145952c99afb6b103d0188ce846c192634
Reviewed-by: Yoann Lopes <yoann.lopes@digia.com>
Reviewed-by: Martin Smith <martin.smith@digia.com>
2013-06-26 11:34:57 +02:00
Sze Howe Koh
09fea23419 Doc: Fix some broken links and quote paths
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>
2013-06-13 16:43:33 +02:00
Topi Reinio
fca12620b1 Doc: Add Qt Multimedia platform notes for Windows
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>
2013-06-04 11:23:10 +02:00
Jerome Pasion
2998a24d35 Doc: Adding import statement for in Qt Multimedia QML Types
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>
2013-06-03 14:54:36 +02:00
Jerome Pasion
23e51e0928 Doc: Removed multimedia overview from "technology-apis" group.
The group in qtdoc was removed.

Change-Id: Ifa8b67421f4eb7b117ee947b186c85bfdd5a8c5d
Reviewed-by: Geir Vattekar <geir.vattekar@digia.com>
2013-05-24 13:28:31 +02:00
Topi Reinio
07f20b8afe Doc: Define example install paths in .qdocconf
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>
2013-05-03 23:16:07 +02:00
Topi Reinio
c34910a22f Doc: Fix example paths referred in documentation
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>
2013-04-30 08:59:32 +02:00
Jerome Pasion
87b413ec9d Doc: Several cosmetic doc fixes.
-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>
2013-04-23 16:58:29 +02:00
Topi Reinio
b315d3e5cd Doc: Fix module names in .qdocconf for Qt Multimedia & Widgets
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>
2013-04-19 11:48:03 +02:00
Jerome Pasion
f641bda2e7 Doc: Adding Qt Multimedia Widgets documentation.
-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>
2013-02-26 01:31:48 +01:00
Frederik Gladhorn
d396262bc9 Merge remote-tracking branch 'origin/stable' into dev
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
2013-02-19 17:15:56 +01:00
Tobias Koenig
01436abd3d Blackberry: Extend platform-specific documentation
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>
2013-02-19 14:45:44 +01:00
Topi Reinio
9ea9d57bbf Doc: Fix faulty snippet in Video Overview page
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>
2013-02-19 14:20:32 +01:00
Oswald Buddenhagen
99190404e1 fix doc page urls
they are versioned nowadays

Change-Id: I5c2ca367b8e63523811c03595cf8a7e326e8a662
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
2013-02-06 09:45:31 +01:00
Oswald Buddenhagen
3f79f0707e substitute fixed version numbers in qdocconf files with variables
Change-Id: I20bd702b481d82903f5f4a42e74a8fb8ad4e71dc
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
2013-02-06 09:44:57 +01:00
Laszlo Papp
aa2dc1ab4b Add a simple accessor to the video provider snippet
Task-number: QTBUG-29383

Change-Id: I744fb997dae6ad1f9b8075791ad463c8fe23a96d
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
2013-02-06 02:55:39 +01:00
Sergio Ahumada
c96d152e33 Merge branch 'release' into stable
Change-Id: If07e76a0f2f46d6dc50a41441324f02393e17d01
2013-01-29 15:21:05 +01:00
Sze Howe Koh
28ee5b12ff Doc: Fix module name format
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>
2013-01-29 01:28:50 +01:00
Jerome Pasion
b01c8274fd Doc: Add QML Types to table of contents in Assistant
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>
2013-01-28 14:18:12 +01:00
Topi Reinio
52ad3219f0 QAudioInput/Output documentation: Fix slot naming in snippets
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>
2013-01-25 16:33:50 +01:00
Jerome Pasion
b671a5f688 Doc: Fixed "QML Types" listing C++ classes.
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>
2013-01-22 14:40:42 +01:00
Venugopal Shivashankar
8e6ffcc6af Doc: Fixed random QDoc warnings
- 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)
2013-01-17 16:03:48 +01:00
Frederik Gladhorn
f462bb9177 Bump Qt version to 5.1.0
Change-Id: I68f5c34fe14860c40537a23f28e741f0ac1eef1e
Reviewed-by: David Faure (KDE) <faure@kde.org>
2013-01-15 16:48:42 +01:00
Venugopal Shivashankar
51334d2995 Doc: Fixed random QDoc warnings
- 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>
2013-01-15 10:48:20 +01:00
Sergio Ahumada
c6b54f3521 doc: Fix namespace version to 5.0.1 for qhp documentation
Change-Id: Ie2d0aeff6d8b63ae9d18896320557d28cc9adb68
Reviewed-by: hjk <qthjk@ovi.com>
2013-01-12 17:48:39 +01:00
Sergio Ahumada
399500f87e Update copyright year in Digia's license headers
Change-Id: Ia8c1c38aba1544603fada8c414cc856f365fd15b
Reviewed-by: Akseli Salovaara <akseli.salovaara@digia.com>
Reviewed-by: Sergio Ahumada <sergio.ahumada@digia.com>
2013-01-10 17:56:01 +01:00
Venugopal Shivashankar
85faa55780 Doc: Moved the qdocinc and image to the sourcedirs
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>
2013-01-02 15:28:47 +01:00
Sergio Ahumada
47b0d553d9 Bump Qt version to 5.0.1
Change-Id: Ic45b749ceea86263281b5c23509bf301fa334e5f
Reviewed-by: Jonas Rabbe <jonas.rabbe@gmail.com>
2012-12-25 12:56:00 +01:00
Venugopal Shivashankar
3bf7a86c07 Doc: Fixed broken links to the Multimedia examples
- 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>
2012-12-14 14:23:22 +01:00
Venugopal Shivashankar
0241b0e39c Doc: Updated the \example and \snippet paths
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>
2012-12-12 17:44:36 +01:00
Venugopal Shivashankar
1315dcf09c Doc: Added missing images and made some language edits
Change-Id: I9544121601c2c4099927e0e23550c3ab32bbfda9
Reviewed-by: Eskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@digia.com>
2012-11-30 15:38:33 +01:00
Andy Nichols
e899ff8c5a Doc: cleanup multimedia overview
Added an introduction, and fix some formatting.

Change-Id: Ic23416cf1113895a1895a53f310530a83a9013d3
Reviewed-by: Paul Olav Tvete <paul.tvete@digia.com>
2012-11-28 09:16:10 +01:00
Andy Nichols
6f638d663c Doc: Cleanup diagram placeholder in Camera Overview
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>
2012-11-27 15:56:31 +01:00
Sze Howe Koh
294fa9c5df Doc: Polish the description of changes to the Qt Multimedia module
- 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>
2012-11-21 09:25:35 +01:00
Eskil Abrahamsen Blomfeldt
d00113c6ac Merge branch 'newdocs'
Change-Id: Ia45daee9b5089c01300cf27484296809dd87302f
2012-11-20 10:24:45 +01:00
Thomas McGuire
e567e098d9 Blackberry: Add a page with platform-specific documentation
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>
2012-11-07 23:20:45 +01:00
Jerome Pasion
e83d04557a Doc: Removed extra qdocconf files.
The variables and macros are in qtbase/doc/global.
Corrected QHP variables.

Change-Id: I4b5816d0d0ce7a228ed27944fb9471f390f7334d
Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-11-07 16:24:31 +01:00
Sze Howe Koh
832c3929f2 Rename namespace QtMultimedia -> QMultimedia
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>
2012-11-06 18:20:06 +01:00