From 011e151c4e010793a004303c67e0df1aa002dfe2 Mon Sep 17 00:00:00 2001 From: Jerome Pasion Date: Fri, 27 Jul 2012 14:51:00 +0200 Subject: Doc: Changed \qmlclass to \qmltype and added \instantiates -New qdoc command \qmltype replaces \qmlclass -\instantiates for determining if the QML type has a C++ implementation Change-Id: I83d1e2c3f376f96ea51afedadf88c3cf478e33d8 Reviewed-by: Martin Smith --- src/imports/audioengine/qdeclarative_attenuationmodel_p.cpp | 6 ++++-- src/imports/audioengine/qdeclarative_audiocategory_p.cpp | 3 ++- src/imports/audioengine/qdeclarative_audioengine_p.cpp | 3 ++- src/imports/audioengine/qdeclarative_audiolistener_p.cpp | 3 ++- src/imports/audioengine/qdeclarative_audiosample_p.cpp | 3 ++- src/imports/audioengine/qdeclarative_playvariation_p.cpp | 3 ++- src/imports/audioengine/qdeclarative_sound_p.cpp | 3 ++- src/imports/audioengine/qdeclarative_soundinstance_p.cpp | 3 ++- src/imports/multimedia/Video.qml | 2 +- src/imports/multimedia/qdeclarativeaudio.cpp | 6 ++++-- src/imports/multimedia/qdeclarativecamera.cpp | 3 ++- src/imports/multimedia/qdeclarativecameracapture.cpp | 3 ++- src/imports/multimedia/qdeclarativecameraexposure.cpp | 3 ++- src/imports/multimedia/qdeclarativecameraflash.cpp | 3 ++- src/imports/multimedia/qdeclarativecamerafocus.cpp | 3 ++- src/imports/multimedia/qdeclarativecameraimageprocessing.cpp | 3 ++- src/imports/multimedia/qdeclarativecamerarecorder.cpp | 3 ++- src/imports/multimedia/qdeclarativeradio.cpp | 3 ++- src/imports/multimedia/qdeclarativeradiodata.cpp | 3 ++- src/imports/multimedia/qdeclarativetorch.cpp | 3 ++- src/imports/multimedia/qdeclarativevideooutput.cpp | 3 ++- src/multimedia/audio/qsoundeffect.cpp | 3 ++- 22 files changed, 47 insertions(+), 24 deletions(-) diff --git a/src/imports/audioengine/qdeclarative_attenuationmodel_p.cpp b/src/imports/audioengine/qdeclarative_attenuationmodel_p.cpp index 00521f5f8..5fba40b9a 100644 --- a/src/imports/audioengine/qdeclarative_attenuationmodel_p.cpp +++ b/src/imports/audioengine/qdeclarative_attenuationmodel_p.cpp @@ -90,7 +90,8 @@ void QDeclarativeAttenuationModel::setName(const QString& name) ////////////////////////////////////////////////////////////////////////////////////////// /*! - \qmlclass AttenuationModelLinear QDeclarativeAttenuationModelLinear + \qmltype AttenuationModelLinear + \instantiates QDeclarativeAttenuationModelLinear \since 1.0 \brief Defines a linear attenuation curve for a \l Sound. \inqmlmodule QtAudioEngine 1.0 @@ -221,7 +222,8 @@ qreal QDeclarativeAttenuationModelLinear::calculateGain(const QVector3D &listene ////////////////////////////////////////////////////////////////////////////////////////// /*! - \qmlclass AttenuationModelInverse QDeclarativeAttenuationModelInverse + \qmltype AttenuationModelInverse + \instantiates QDeclarativeAttenuationModelInverse \since 1.0 \brief Defines a non-linear attenuation curve for a \l Sound. diff --git a/src/imports/audioengine/qdeclarative_audiocategory_p.cpp b/src/imports/audioengine/qdeclarative_audiocategory_p.cpp index 223175a1d..d74790ed1 100644 --- a/src/imports/audioengine/qdeclarative_audiocategory_p.cpp +++ b/src/imports/audioengine/qdeclarative_audiocategory_p.cpp @@ -47,7 +47,8 @@ QT_USE_NAMESPACE /*! - \qmlclass AudioCategory QDeclarativeAudioCategory + \qmltype AudioCategory + \instantiates QDeclarativeAudioCategory \since 1.0 \brief Control all active sound instances by group. \inqmlmodule QtAudioEngine 1.0 diff --git a/src/imports/audioengine/qdeclarative_audioengine_p.cpp b/src/imports/audioengine/qdeclarative_audioengine_p.cpp index 1275523ac..9e2fe7107 100644 --- a/src/imports/audioengine/qdeclarative_audioengine_p.cpp +++ b/src/imports/audioengine/qdeclarative_audioengine_p.cpp @@ -56,7 +56,8 @@ QT_BEGIN_NAMESPACE /*! - \qmlclass AudioEngine QDeclarativeAudioEngine + \qmltype AudioEngine + \instantiates QDeclarativeAudioEngine \since 1.0 \brief Organize all your 3d audio content in one place. \inqmlmodule QtAudioEngine 1.0 diff --git a/src/imports/audioengine/qdeclarative_audiolistener_p.cpp b/src/imports/audioengine/qdeclarative_audiolistener_p.cpp index 91816b038..5f22fc640 100644 --- a/src/imports/audioengine/qdeclarative_audiolistener_p.cpp +++ b/src/imports/audioengine/qdeclarative_audiolistener_p.cpp @@ -48,7 +48,8 @@ QT_USE_NAMESPACE /*! - \qmlclass AudioListener QDeclarativeAudioListener + \qmltype AudioListener + \instantiates QDeclarativeAudioListener \since 1.0 \brief Control global listener parameters. \inqmlmodule QtAudioEngine 1.0 diff --git a/src/imports/audioengine/qdeclarative_audiosample_p.cpp b/src/imports/audioengine/qdeclarative_audiosample_p.cpp index c645bb1b8..4694af399 100644 --- a/src/imports/audioengine/qdeclarative_audiosample_p.cpp +++ b/src/imports/audioengine/qdeclarative_audiosample_p.cpp @@ -50,7 +50,8 @@ QT_USE_NAMESPACE /*! - \qmlclass AudioSample QDeclarativeAudioSample + \qmltype AudioSample + \instantiates QDeclarativeAudioSample \since 1.0 \brief Load audio samples, mostly .wav. \inqmlmodule QtAudioEngine 1.0 diff --git a/src/imports/audioengine/qdeclarative_playvariation_p.cpp b/src/imports/audioengine/qdeclarative_playvariation_p.cpp index 3f78ce048..aae4120b7 100644 --- a/src/imports/audioengine/qdeclarative_playvariation_p.cpp +++ b/src/imports/audioengine/qdeclarative_playvariation_p.cpp @@ -49,7 +49,8 @@ QT_USE_NAMESPACE /*! - \qmlclass PlayVariation QDeclarativePlayVariation + \qmltype PlayVariation + \instantiates QDeclarativePlayVariation \since 1.0 \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 diff --git a/src/imports/audioengine/qdeclarative_sound_p.cpp b/src/imports/audioengine/qdeclarative_sound_p.cpp index 22eb4e3a8..5f3a5a143 100644 --- a/src/imports/audioengine/qdeclarative_sound_p.cpp +++ b/src/imports/audioengine/qdeclarative_sound_p.cpp @@ -138,7 +138,8 @@ void QDeclarativeSoundCone::componentComplete() //////////////////////////////////////////////////////////// /*! - \qmlclass Sound QDeclarativeSound + \qmltype Sound + \instantiates QDeclarativeSound \since 1.0 \brief Define a variety of samples and parameters to be used for SoundInstance. diff --git a/src/imports/audioengine/qdeclarative_soundinstance_p.cpp b/src/imports/audioengine/qdeclarative_soundinstance_p.cpp index 241a79b96..06769a71e 100644 --- a/src/imports/audioengine/qdeclarative_soundinstance_p.cpp +++ b/src/imports/audioengine/qdeclarative_soundinstance_p.cpp @@ -51,7 +51,8 @@ QT_USE_NAMESPACE /*! - \qmlclass SoundInstance QDeclarativeSoundInstance + \qmltype SoundInstance + \instantiates QDeclarativeSoundInstance \since 1.0 \brief Play 3d audio content. \inqmlmodule QtAudioEngine 1.0 diff --git a/src/imports/multimedia/Video.qml b/src/imports/multimedia/Video.qml index b0454d7ce..bd9ef3738 100644 --- a/src/imports/multimedia/Video.qml +++ b/src/imports/multimedia/Video.qml @@ -43,7 +43,7 @@ import QtQuick 2.0 import QtMultimedia 5.0 /*! - \qmlclass Video + \qmltype Video \inherits Item \ingroup multimedia_qml \ingroup multimedia_video_qml diff --git a/src/imports/multimedia/qdeclarativeaudio.cpp b/src/imports/multimedia/qdeclarativeaudio.cpp index e9fda4f5a..797542ad0 100644 --- a/src/imports/multimedia/qdeclarativeaudio.cpp +++ b/src/imports/multimedia/qdeclarativeaudio.cpp @@ -57,7 +57,8 @@ QT_BEGIN_NAMESPACE /*! - \qmlclass Audio QDeclarativeAudio + \qmltype Audio + \instantiates QDeclarativeAudio \brief Add audio playback to a scene. \inqmlmodule QtMultimedia 5.0 @@ -1118,7 +1119,8 @@ void QDeclarativeAudio::_q_statusChanged() ///////////// MediaPlayer Docs ///////////// /*! - \qmlclass MediaPlayer QDeclarativeAudio + \qmltype MediaPlayer + \instantiates QDeclarativeAudio \brief Add media playback to a scene. \inqmlmodule QtMultimedia 5.0 diff --git a/src/imports/multimedia/qdeclarativecamera.cpp b/src/imports/multimedia/qdeclarativecamera.cpp index d1219add1..b082b55d0 100644 --- a/src/imports/multimedia/qdeclarativecamera.cpp +++ b/src/imports/multimedia/qdeclarativecamera.cpp @@ -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. \ingroup multimedia_qml \ingroup camera_qml diff --git a/src/imports/multimedia/qdeclarativecameracapture.cpp b/src/imports/multimedia/qdeclarativecameracapture.cpp index 663a805f1..f5a072f16 100644 --- a/src/imports/multimedia/qdeclarativecameracapture.cpp +++ b/src/imports/multimedia/qdeclarativecameracapture.cpp @@ -50,7 +50,8 @@ QT_BEGIN_NAMESPACE /*! - \qmlclass CameraCapture QDeclarativeCameraCapture + \qmltype CameraCapture + \instantiates QDeclarativeCameraCapture \brief An interface for capturing camera images \ingroup multimedia_qml \inqmlmodule QtMultimedia 5.0 diff --git a/src/imports/multimedia/qdeclarativecameraexposure.cpp b/src/imports/multimedia/qdeclarativecameraexposure.cpp index 0388085d5..e9b7f880b 100644 --- a/src/imports/multimedia/qdeclarativecameraexposure.cpp +++ b/src/imports/multimedia/qdeclarativecameraexposure.cpp @@ -45,7 +45,8 @@ QT_BEGIN_NAMESPACE /*! - \qmlclass CameraExposure QDeclarativeCameraExposure + \qmltype CameraExposure + \instantiates QDeclarativeCameraExposure \brief An interface for exposure related camera settings. \ingroup multimedia_qml \ingroup camera_qml diff --git a/src/imports/multimedia/qdeclarativecameraflash.cpp b/src/imports/multimedia/qdeclarativecameraflash.cpp index 7048a2cd9..fb1256319 100644 --- a/src/imports/multimedia/qdeclarativecameraflash.cpp +++ b/src/imports/multimedia/qdeclarativecameraflash.cpp @@ -45,7 +45,8 @@ QT_BEGIN_NAMESPACE /*! - \qmlclass CameraFlash QDeclarativeCameraFlash + \qmltype CameraFlash + \instantiates QDeclarativeCameraFlash \inqmlmodule QtMultimedia 5.0 \brief An interface for flash related camera settings. \ingroup multimedia_qml diff --git a/src/imports/multimedia/qdeclarativecamerafocus.cpp b/src/imports/multimedia/qdeclarativecamerafocus.cpp index 70a737ca1..80fa9ce20 100644 --- a/src/imports/multimedia/qdeclarativecamerafocus.cpp +++ b/src/imports/multimedia/qdeclarativecamerafocus.cpp @@ -45,7 +45,8 @@ QT_BEGIN_NAMESPACE /*! - \qmlclass CameraFocus QDeclarativeCameraFocus + \qmltype CameraFocus + \instantiates QDeclarativeCameraFocus \inqmlmodule QtMultimedia 5.0 \brief An interface for focus related camera settings. \ingroup multimedia_qml diff --git a/src/imports/multimedia/qdeclarativecameraimageprocessing.cpp b/src/imports/multimedia/qdeclarativecameraimageprocessing.cpp index 88e82f976..294b20dc6 100644 --- a/src/imports/multimedia/qdeclarativecameraimageprocessing.cpp +++ b/src/imports/multimedia/qdeclarativecameraimageprocessing.cpp @@ -45,7 +45,8 @@ QT_BEGIN_NAMESPACE /*! - \qmlclass CameraImageProcessing QDeclarativeCameraImageProcessing + \qmltype CameraImageProcessing + \instantiates QDeclarativeCameraImageProcessing \inqmlmodule QtMultimedia 5.0 \brief An interface for camera capture related settings. \ingroup multimedia_qml diff --git a/src/imports/multimedia/qdeclarativecamerarecorder.cpp b/src/imports/multimedia/qdeclarativecamerarecorder.cpp index 52742493b..ccf87a219 100644 --- a/src/imports/multimedia/qdeclarativecamerarecorder.cpp +++ b/src/imports/multimedia/qdeclarativecamerarecorder.cpp @@ -47,7 +47,8 @@ QT_BEGIN_NAMESPACE /*! - \qmlclass CameraRecorder QDeclarativeCameraRecorder + \qmltype CameraRecorder + \instantiates QDeclarativeCameraRecorder \inqmlmodule QtMultimedia 5.0 \brief Controls video recording with the Camera. \ingroup multimedia_qml diff --git a/src/imports/multimedia/qdeclarativeradio.cpp b/src/imports/multimedia/qdeclarativeradio.cpp index 74d7d496c..e76a1f07b 100644 --- a/src/imports/multimedia/qdeclarativeradio.cpp +++ b/src/imports/multimedia/qdeclarativeradio.cpp @@ -45,7 +45,8 @@ QT_BEGIN_NAMESPACE /*! - \qmlclass Radio QDeclarativeRadio + \qmltype Radio + \instantiates QDeclarativeRadio \inqmlmodule QtMultimedia 5.0 \brief Access radio functionality from a QML application. \ingroup multimedia_qml diff --git a/src/imports/multimedia/qdeclarativeradiodata.cpp b/src/imports/multimedia/qdeclarativeradiodata.cpp index b03579ec1..4b9300161 100644 --- a/src/imports/multimedia/qdeclarativeradiodata.cpp +++ b/src/imports/multimedia/qdeclarativeradiodata.cpp @@ -44,7 +44,8 @@ QT_BEGIN_NAMESPACE /*! - \qmlclass RadioData QDeclarativeRadioData + \qmltype RadioData + \instantiates QDeclarativeRadioData \inqmlmodule QtMultimedia 5.0 \brief Access RDS data from a QML application. \ingroup multimedia_qml diff --git a/src/imports/multimedia/qdeclarativetorch.cpp b/src/imports/multimedia/qdeclarativetorch.cpp index 743877347..b884a2f33 100644 --- a/src/imports/multimedia/qdeclarativetorch.cpp +++ b/src/imports/multimedia/qdeclarativetorch.cpp @@ -47,7 +47,8 @@ QT_BEGIN_NAMESPACE /*! - \qmlclass Torch QDeclarativeTorch + \qmltype Torch + \instantiates QDeclarativeTorch \inqmlmodule QtMultimedia 5.0 \brief Simple control over torch functionality diff --git a/src/imports/multimedia/qdeclarativevideooutput.cpp b/src/imports/multimedia/qdeclarativevideooutput.cpp index fc996f453..9873083a5 100644 --- a/src/imports/multimedia/qdeclarativevideooutput.cpp +++ b/src/imports/multimedia/qdeclarativevideooutput.cpp @@ -51,7 +51,8 @@ QT_BEGIN_NAMESPACE /*! - \qmlclass VideoOutput QDeclarativeVideoOutput + \qmltype VideoOutput + \instantiates QDeclarativeVideoOutput \brief Render video or camera viewfinder. \ingroup multimedia_qml diff --git a/src/multimedia/audio/qsoundeffect.cpp b/src/multimedia/audio/qsoundeffect.cpp index 373e6fb0d..9c0eece63 100644 --- a/src/multimedia/audio/qsoundeffect.cpp +++ b/src/multimedia/audio/qsoundeffect.cpp @@ -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. \inmodule QtMultimedia -- cgit v1.2.3