Doc: Changed \qmlclass to \qmltype and added \instantiates

-New qdoc command \qmltype replaces \qmlclass
-\instantiates <C++ class> for determining if the QML type has a C++
implementation

Change-Id: I83d1e2c3f376f96ea51afedadf88c3cf478e33d8
Reviewed-by: Martin Smith <martin.smith@nokia.com>
This commit is contained in:
Jerome Pasion
2012-07-27 14:51:00 +02:00
committed by Qt by Nokia
parent b976589a66
commit 011e151c4e
22 changed files with 47 additions and 24 deletions

View File

@@ -90,7 +90,8 @@ void QDeclarativeAttenuationModel::setName(const QString& name)
////////////////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////////////////
/*! /*!
\qmlclass AttenuationModelLinear QDeclarativeAttenuationModelLinear \qmltype AttenuationModelLinear
\instantiates QDeclarativeAttenuationModelLinear
\since 1.0 \since 1.0
\brief Defines a linear attenuation curve for a \l Sound. \brief Defines a linear attenuation curve for a \l Sound.
\inqmlmodule QtAudioEngine 1.0 \inqmlmodule QtAudioEngine 1.0
@@ -221,7 +222,8 @@ qreal QDeclarativeAttenuationModelLinear::calculateGain(const QVector3D &listene
////////////////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////////////////
/*! /*!
\qmlclass AttenuationModelInverse QDeclarativeAttenuationModelInverse \qmltype AttenuationModelInverse
\instantiates QDeclarativeAttenuationModelInverse
\since 1.0 \since 1.0
\brief Defines a non-linear attenuation curve for a \l Sound. \brief Defines a non-linear attenuation curve for a \l Sound.

View File

@@ -47,7 +47,8 @@
QT_USE_NAMESPACE QT_USE_NAMESPACE
/*! /*!
\qmlclass AudioCategory QDeclarativeAudioCategory \qmltype AudioCategory
\instantiates QDeclarativeAudioCategory
\since 1.0 \since 1.0
\brief Control all active sound instances by group. \brief Control all active sound instances by group.
\inqmlmodule QtAudioEngine 1.0 \inqmlmodule QtAudioEngine 1.0

View File

@@ -56,7 +56,8 @@
QT_BEGIN_NAMESPACE QT_BEGIN_NAMESPACE
/*! /*!
\qmlclass AudioEngine QDeclarativeAudioEngine \qmltype AudioEngine
\instantiates QDeclarativeAudioEngine
\since 1.0 \since 1.0
\brief Organize all your 3d audio content in one place. \brief Organize all your 3d audio content in one place.
\inqmlmodule QtAudioEngine 1.0 \inqmlmodule QtAudioEngine 1.0

View File

@@ -48,7 +48,8 @@
QT_USE_NAMESPACE QT_USE_NAMESPACE
/*! /*!
\qmlclass AudioListener QDeclarativeAudioListener \qmltype AudioListener
\instantiates QDeclarativeAudioListener
\since 1.0 \since 1.0
\brief Control global listener parameters. \brief Control global listener parameters.
\inqmlmodule QtAudioEngine 1.0 \inqmlmodule QtAudioEngine 1.0

View File

@@ -50,7 +50,8 @@
QT_USE_NAMESPACE QT_USE_NAMESPACE
/*! /*!
\qmlclass AudioSample QDeclarativeAudioSample \qmltype AudioSample
\instantiates QDeclarativeAudioSample
\since 1.0 \since 1.0
\brief Load audio samples, mostly .wav. \brief Load audio samples, mostly .wav.
\inqmlmodule QtAudioEngine 1.0 \inqmlmodule QtAudioEngine 1.0

View File

@@ -49,7 +49,8 @@
QT_USE_NAMESPACE QT_USE_NAMESPACE
/*! /*!
\qmlclass PlayVariation QDeclarativePlayVariation \qmltype PlayVariation
\instantiates QDeclarativePlayVariation
\since 1.0 \since 1.0
\brief Define a playback variation for \l {Sound} {sounds}. \brief Define a playback variation for \l {Sound} {sounds}.
So each time the playback of the same sound can be a slightly different even with the same So each time the playback of the same sound can be a slightly different even with the same

View File

@@ -138,7 +138,8 @@ void QDeclarativeSoundCone::componentComplete()
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/*! /*!
\qmlclass Sound QDeclarativeSound \qmltype Sound
\instantiates QDeclarativeSound
\since 1.0 \since 1.0
\brief Define a variety of samples and parameters to be used for \brief Define a variety of samples and parameters to be used for
SoundInstance. SoundInstance.

View File

@@ -51,7 +51,8 @@
QT_USE_NAMESPACE QT_USE_NAMESPACE
/*! /*!
\qmlclass SoundInstance QDeclarativeSoundInstance \qmltype SoundInstance
\instantiates QDeclarativeSoundInstance
\since 1.0 \since 1.0
\brief Play 3d audio content. \brief Play 3d audio content.
\inqmlmodule QtAudioEngine 1.0 \inqmlmodule QtAudioEngine 1.0

View File

@@ -43,7 +43,7 @@ import QtQuick 2.0
import QtMultimedia 5.0 import QtMultimedia 5.0
/*! /*!
\qmlclass Video \qmltype Video
\inherits Item \inherits Item
\ingroup multimedia_qml \ingroup multimedia_qml
\ingroup multimedia_video_qml \ingroup multimedia_video_qml

View File

@@ -57,7 +57,8 @@
QT_BEGIN_NAMESPACE QT_BEGIN_NAMESPACE
/*! /*!
\qmlclass Audio QDeclarativeAudio \qmltype Audio
\instantiates QDeclarativeAudio
\brief Add audio playback to a scene. \brief Add audio playback to a scene.
\inqmlmodule QtMultimedia 5.0 \inqmlmodule QtMultimedia 5.0
@@ -1118,7 +1119,8 @@ void QDeclarativeAudio::_q_statusChanged()
///////////// MediaPlayer Docs ///////////// ///////////// MediaPlayer Docs /////////////
/*! /*!
\qmlclass MediaPlayer QDeclarativeAudio \qmltype MediaPlayer
\instantiates QDeclarativeAudio
\brief Add media playback to a scene. \brief Add media playback to a scene.
\inqmlmodule QtMultimedia 5.0 \inqmlmodule QtMultimedia 5.0

View File

@@ -74,7 +74,8 @@ void QDeclarativeCamera::_q_availabilityChanged(QtMultimedia::AvailabilityStatus
} }
/*! /*!
\qmlclass Camera QDeclarativeCamera \qmltype Camera
\instantiates QDeclarativeCamera
\brief Access viewfinder frames, and take photos and movies. \brief Access viewfinder frames, and take photos and movies.
\ingroup multimedia_qml \ingroup multimedia_qml
\ingroup camera_qml \ingroup camera_qml

View File

@@ -50,7 +50,8 @@
QT_BEGIN_NAMESPACE QT_BEGIN_NAMESPACE
/*! /*!
\qmlclass CameraCapture QDeclarativeCameraCapture \qmltype CameraCapture
\instantiates QDeclarativeCameraCapture
\brief An interface for capturing camera images \brief An interface for capturing camera images
\ingroup multimedia_qml \ingroup multimedia_qml
\inqmlmodule QtMultimedia 5.0 \inqmlmodule QtMultimedia 5.0

View File

@@ -45,7 +45,8 @@
QT_BEGIN_NAMESPACE QT_BEGIN_NAMESPACE
/*! /*!
\qmlclass CameraExposure QDeclarativeCameraExposure \qmltype CameraExposure
\instantiates QDeclarativeCameraExposure
\brief An interface for exposure related camera settings. \brief An interface for exposure related camera settings.
\ingroup multimedia_qml \ingroup multimedia_qml
\ingroup camera_qml \ingroup camera_qml

View File

@@ -45,7 +45,8 @@
QT_BEGIN_NAMESPACE QT_BEGIN_NAMESPACE
/*! /*!
\qmlclass CameraFlash QDeclarativeCameraFlash \qmltype CameraFlash
\instantiates QDeclarativeCameraFlash
\inqmlmodule QtMultimedia 5.0 \inqmlmodule QtMultimedia 5.0
\brief An interface for flash related camera settings. \brief An interface for flash related camera settings.
\ingroup multimedia_qml \ingroup multimedia_qml

View File

@@ -45,7 +45,8 @@
QT_BEGIN_NAMESPACE QT_BEGIN_NAMESPACE
/*! /*!
\qmlclass CameraFocus QDeclarativeCameraFocus \qmltype CameraFocus
\instantiates QDeclarativeCameraFocus
\inqmlmodule QtMultimedia 5.0 \inqmlmodule QtMultimedia 5.0
\brief An interface for focus related camera settings. \brief An interface for focus related camera settings.
\ingroup multimedia_qml \ingroup multimedia_qml

View File

@@ -45,7 +45,8 @@
QT_BEGIN_NAMESPACE QT_BEGIN_NAMESPACE
/*! /*!
\qmlclass CameraImageProcessing QDeclarativeCameraImageProcessing \qmltype CameraImageProcessing
\instantiates QDeclarativeCameraImageProcessing
\inqmlmodule QtMultimedia 5.0 \inqmlmodule QtMultimedia 5.0
\brief An interface for camera capture related settings. \brief An interface for camera capture related settings.
\ingroup multimedia_qml \ingroup multimedia_qml

View File

@@ -47,7 +47,8 @@
QT_BEGIN_NAMESPACE QT_BEGIN_NAMESPACE
/*! /*!
\qmlclass CameraRecorder QDeclarativeCameraRecorder \qmltype CameraRecorder
\instantiates QDeclarativeCameraRecorder
\inqmlmodule QtMultimedia 5.0 \inqmlmodule QtMultimedia 5.0
\brief Controls video recording with the Camera. \brief Controls video recording with the Camera.
\ingroup multimedia_qml \ingroup multimedia_qml

View File

@@ -45,7 +45,8 @@
QT_BEGIN_NAMESPACE QT_BEGIN_NAMESPACE
/*! /*!
\qmlclass Radio QDeclarativeRadio \qmltype Radio
\instantiates QDeclarativeRadio
\inqmlmodule QtMultimedia 5.0 \inqmlmodule QtMultimedia 5.0
\brief Access radio functionality from a QML application. \brief Access radio functionality from a QML application.
\ingroup multimedia_qml \ingroup multimedia_qml

View File

@@ -44,7 +44,8 @@
QT_BEGIN_NAMESPACE QT_BEGIN_NAMESPACE
/*! /*!
\qmlclass RadioData QDeclarativeRadioData \qmltype RadioData
\instantiates QDeclarativeRadioData
\inqmlmodule QtMultimedia 5.0 \inqmlmodule QtMultimedia 5.0
\brief Access RDS data from a QML application. \brief Access RDS data from a QML application.
\ingroup multimedia_qml \ingroup multimedia_qml

View File

@@ -47,7 +47,8 @@
QT_BEGIN_NAMESPACE QT_BEGIN_NAMESPACE
/*! /*!
\qmlclass Torch QDeclarativeTorch \qmltype Torch
\instantiates QDeclarativeTorch
\inqmlmodule QtMultimedia 5.0 \inqmlmodule QtMultimedia 5.0
\brief Simple control over torch functionality \brief Simple control over torch functionality

View File

@@ -51,7 +51,8 @@
QT_BEGIN_NAMESPACE QT_BEGIN_NAMESPACE
/*! /*!
\qmlclass VideoOutput QDeclarativeVideoOutput \qmltype VideoOutput
\instantiates QDeclarativeVideoOutput
\brief Render video or camera viewfinder. \brief Render video or camera viewfinder.
\ingroup multimedia_qml \ingroup multimedia_qml

View File

@@ -82,7 +82,8 @@ QT_BEGIN_NAMESPACE
/*! /*!
\qmlclass SoundEffect QSoundEffect \qmltype SoundEffect
\instantiates QSoundEffect
\brief The SoundEffect type provides a way to play sound effects in QML. \brief The SoundEffect type provides a way to play sound effects in QML.
\inmodule QtMultimedia \inmodule QtMultimedia