A number of documentation fixes.

* Remove references to private QMediaServiceProvider class and point
  new backend writers to irc/mailing lists
* Wrong or missing parameter names
* Fix a few links
* Correct a few property data types
* Various other things to keep qdoc happier

Change-Id: I5c8800d65c00f0783541afef35990bd3918acab7
Reviewed-by: Angus Cummings <angus.cummings@nokia.com>
Reviewed-by: Ling Hu <ling.hu@nokia.com>
Reviewed-by: Daniel Kovacic <daniel.kovacic@nokia.com>
This commit is contained in:
Michael Goddard
2012-06-06 12:28:34 +10:00
committed by Qt by Nokia
parent a8ec84e3ca
commit f53788ae42
10 changed files with 47 additions and 32 deletions

View File

@@ -53,13 +53,14 @@ this by implementing certain control and service classes, as detailed below.
For the developer who wishes to extend the functionality of the Qt Multimedia
classes there are several classes of particular importance. The classes
providing default functionality are QMediaService, QMediaServiceProvider and
QMediaControl.
QMediaControl. Some of these classes are not in the public API since they
are very seldom useful to application developers.
to extend the Multimedia API you would use the following three classes or
To extend the Multimedia API you would use the following three classes or
classes derived from them.
\list
\li \l QMediaServiceProvider is used by the top level client class to
\li QMediaServiceProvider is used by the top level client class to
request a service. The top level class knowing what kind of service it needs.
\li \l QMediaService provides a service and when asked by the top level
@@ -89,6 +90,11 @@ for the interface.
\section2 Adding a Media Service Provider
In general, adding a new media service provider is outside the scope of this documentation.
For best results, consult the existing provider source code, and seek assistance on the relevant
mailing lists and IRC channels.
\omit
The base class for creating new service providers is \l{QMediaServiceProvider}.
The user must implement the \l{QMediaServiceProvider::requestService()}{requestService()}
function
@@ -123,6 +129,8 @@ Other methods that may be overloaded
The choice of what needs to be done depends on what the developer wishes to do with the service.
\endomit
\section2 Classes for service implementers.
\annotatedlist multimedia_control