slapin/qtmultimedia
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Remove antiquated \since lines in docs.

Browse Source 
They aren't useful in the case of QtMultimedia{Kit}

Change-Id: If1b0b6625763c85907fb05beb9c440046472ddef
Reviewed-by: Jonas Rabbe <jonas.rabbe@nokia.com>
This commit is contained in:
Michael Goddard
2012-01-16 15:19:20 +10:00
committed by Qt by Nokia
parent b228ff95d7
commit a6268601c9
81 changed files with 0 additions and 1319 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
src/multimedia/recording/qmediaencodersettings.cpp
View File

@@ -87,7 +87,6 @@ private:
\inmodule QtMultimedia
\ingroup multimedia
\since 1.0
A audio encoder settings object is used to specify the audio encoder
settings used by QMediaRecorder. Audio encoder settings are selected by
@@ -110,7 +109,6 @@ QAudioEncoderSettings::QAudioEncoderSettings()
/*!
Constructs a copy of the audio encoder settings object \a other.
\since 1.0
*/
QAudioEncoderSettings::QAudioEncoderSettings(const QAudioEncoderSettings& other)
@@ -128,7 +126,6 @@ QAudioEncoderSettings::~QAudioEncoderSettings()
/*!
Assigns the value of \a other to an audio encoder settings object.
\since 1.0
*/
QAudioEncoderSettings& QAudioEncoderSettings::operator=(const QAudioEncoderSettings &other)
@@ -143,7 +140,6 @@ QAudioEncoderSettings& QAudioEncoderSettings::operator=(const QAudioEncoderSetti
Returns true if the settings objects are of equal value, and false if they
are not of equal value.
\since 1.0
*/
bool QAudioEncoderSettings::operator==(const QAudioEncoderSettings &other) const
@@ -164,7 +160,6 @@ bool QAudioEncoderSettings::operator==(const QAudioEncoderSettings &other) const
Returns true if the settings objects are not of equal value, and true if
they are of equal value.
\since 1.0
*/
bool QAudioEncoderSettings::operator!=(const QAudioEncoderSettings &other) const
@@ -176,7 +171,6 @@ bool QAudioEncoderSettings::operator!=(const QAudioEncoderSettings &other) const
Identifies if an audio settings object is initialized.
Returns true if the settings object is null, and false if it is not.
\since 1.0
*/
bool QAudioEncoderSettings::isNull() const
@@ -187,7 +181,6 @@ bool QAudioEncoderSettings::isNull() const
/*!
Returns the audio encoding mode.
\since 1.0
\sa QtMultimedia::EncodingMode
*/
QtMultimedia::EncodingMode QAudioEncoderSettings::encodingMode() const
@@ -205,7 +198,6 @@ QtMultimedia::EncodingMode QAudioEncoderSettings::encodingMode() const
The audio codec, channels count and sample rate settings are used in all
the encoding modes.
\since 1.0
\sa encodingMode(), QtMultimedia::EncodingMode
*/
void QAudioEncoderSettings::setEncodingMode(QtMultimedia::EncodingMode mode)
@@ -215,7 +207,6 @@ void QAudioEncoderSettings::setEncodingMode(QtMultimedia::EncodingMode mode)
/*!
Returns the audio codec.
\since 1.0
*/
QString QAudioEncoderSettings::codec() const
{
@@ -224,7 +215,6 @@ QString QAudioEncoderSettings::codec() const
/*!
Sets the audio \a codec.
\since 1.0
*/
void QAudioEncoderSettings::setCodec(const QString& codec)
{
@@ -234,7 +224,6 @@ void QAudioEncoderSettings::setCodec(const QString& codec)
/*!
Returns the bit rate of the compressed audio stream in bits per second.
\since 1.0
*/
int QAudioEncoderSettings::bitRate() const
{
@@ -243,7 +232,6 @@ int QAudioEncoderSettings::bitRate() const
/*!
Returns the number of audio channels.
\since 1.0
*/
int QAudioEncoderSettings::channelCount() const
{
@@ -255,7 +243,6 @@ int QAudioEncoderSettings::channelCount() const
A value of -1 indicates the encoder should make an optimal choice based on
what is available from the audio source and the limitations of the codec.
\since 1.0
*/
void QAudioEncoderSettings::setChannelCount(int channels)
{
@@ -265,7 +252,6 @@ void QAudioEncoderSettings::setChannelCount(int channels)
/*!
Sets the audio bit \a rate in bits per second.
\since 1.0
*/
void QAudioEncoderSettings::setBitRate(int rate)
{
@@ -275,7 +261,6 @@ void QAudioEncoderSettings::setBitRate(int rate)
/*!
Returns the audio sample rate in Hz.
\since 1.0
*/
int QAudioEncoderSettings::sampleRate() const
{
@@ -287,7 +272,6 @@ int QAudioEncoderSettings::sampleRate() const
A value of -1 indicates the encoder should make an optimal choice based on what is avaialbe
from the audio source and the limitations of the codec.
\since 1.0
*/
void QAudioEncoderSettings::setSampleRate(int rate)
{
@@ -297,7 +281,6 @@ void QAudioEncoderSettings::setSampleRate(int rate)
/*!
Returns the audio encoding quality.
\since 1.0
*/
QtMultimedia::EncodingQuality QAudioEncoderSettings::quality() const
@@ -313,7 +296,6 @@ QtMultimedia::EncodingQuality QAudioEncoderSettings::quality() const
The \a quality settings parameter is only used in the
\l {QtMultimedia::ConstantQualityEncoding}{constant quality} \l{encodingMode()}{encoding mode}.
\since 1.0
*/
void QAudioEncoderSettings::setQuality(QtMultimedia::EncodingQuality quality)
{
@@ -361,7 +343,6 @@ private:
\class QVideoEncoderSettings
\brief The QVideoEncoderSettings class provides a set of video encoder settings.
\since 1.0
A video encoder settings object is used to specify the video encoder
settings used by QMediaRecorder. Video encoder settings are selected by
@@ -385,7 +366,6 @@ QVideoEncoderSettings::QVideoEncoderSettings()
/*!
Constructs a copy of the video encoder settings object \a other.
\since 1.0
*/
QVideoEncoderSettings::QVideoEncoderSettings(const QVideoEncoderSettings& other)
@@ -403,7 +383,6 @@ QVideoEncoderSettings::~QVideoEncoderSettings()
/*!
Assigns the value of \a other to a video encoder settings object.
\since 1.0
*/
QVideoEncoderSettings &QVideoEncoderSettings::operator=(const QVideoEncoderSettings &other)
{
@@ -416,7 +395,6 @@ QVideoEncoderSettings &QVideoEncoderSettings::operator=(const QVideoEncoderSetti
Returns true if the settings objects are of equal value, and false if they
are not of equal value.
\since 1.0
*/
bool QVideoEncoderSettings::operator==(const QVideoEncoderSettings &other) const
{
@@ -435,7 +413,6 @@ bool QVideoEncoderSettings::operator==(const QVideoEncoderSettings &other) const
Returns true if the settings objects are not of equal value, and false if
they are of equal value.
\since 1.0
*/
bool QVideoEncoderSettings::operator!=(const QVideoEncoderSettings &other) const
{
@@ -446,7 +423,6 @@ bool QVideoEncoderSettings::operator!=(const QVideoEncoderSettings &other) const
Identifies if a video encoder settings object is uninitalized.
Returns true if the settings are null, and false if they are not.
\since 1.0
*/
bool QVideoEncoderSettings::isNull() const
{
@@ -456,7 +432,6 @@ bool QVideoEncoderSettings::isNull() const
/*!
Returns the video encoding mode.
\since 1.0
\sa QtMultimedia::EncodingMode
*/
QtMultimedia::EncodingMode QVideoEncoderSettings::encodingMode() const
@@ -473,7 +448,6 @@ QtMultimedia::EncodingMode QVideoEncoderSettings::encodingMode() const
The rest of encoding settings are respected regardless of encoding mode.
\since 1.0
\sa QtMultimedia::EncodingMode
*/
void QVideoEncoderSettings::setEncodingMode(QtMultimedia::EncodingMode mode)
@@ -484,7 +458,6 @@ void QVideoEncoderSettings::setEncodingMode(QtMultimedia::EncodingMode mode)
/*!
Returns the video codec.
\since 1.0
*/
QString QVideoEncoderSettings::codec() const
@@ -494,7 +467,6 @@ QString QVideoEncoderSettings::codec() const
/*!
Sets the video \a codec.
\since 1.0
*/
void QVideoEncoderSettings::setCodec(const QString& codec)
{
@@ -504,7 +476,6 @@ void QVideoEncoderSettings::setCodec(const QString& codec)
/*!
Returns bit rate of the encoded video stream in bits per second.
\since 1.0
*/
int QVideoEncoderSettings::bitRate() const
{
@@ -513,7 +484,6 @@ int QVideoEncoderSettings::bitRate() const
/*!
Sets the bit rate of the encoded video stream to \a value.
\since 1.0
*/
void QVideoEncoderSettings::setBitRate(int value)
@@ -524,7 +494,6 @@ void QVideoEncoderSettings::setBitRate(int value)
/*!
Returns the video frame rate.
\since 1.0
*/
qreal QVideoEncoderSettings::frameRate() const
{
@@ -538,7 +507,6 @@ qreal QVideoEncoderSettings::frameRate() const
A value of 0 indicates the encoder should make an optimal choice based on what is available
from the video source and the limitations of the codec.
\since 1.0
*/
void QVideoEncoderSettings::setFrameRate(qreal rate)
@@ -549,7 +517,6 @@ void QVideoEncoderSettings::setFrameRate(qreal rate)
/*!
Returns the resolution of the encoded video.
\since 1.0
*/
QSize QVideoEncoderSettings::resolution() const
@@ -562,7 +529,6 @@ QSize QVideoEncoderSettings::resolution() const
An empty QSize indicates the encoder should make an optimal choice based on
what is available from the video source and the limitations of the codec.
\since 1.0
*/
void QVideoEncoderSettings::setResolution(const QSize &resolution)
@@ -575,7 +541,6 @@ void QVideoEncoderSettings::setResolution(const QSize &resolution)
Sets the \a width and \a height of the resolution of the encoded video.
\overload
\since 1.0
*/
void QVideoEncoderSettings::setResolution(int width, int height)
@@ -586,7 +551,6 @@ void QVideoEncoderSettings::setResolution(int width, int height)
/*!
Returns the video encoding quality.
\since 1.0
*/
QtMultimedia::EncodingQuality QVideoEncoderSettings::quality() const
@@ -605,7 +569,6 @@ QtMultimedia::EncodingQuality QVideoEncoderSettings::quality() const
The \a quality settings parameter is only used in the \l
{QtMultimedia::ConstantQualityEncoding}{constant quality}
\l{encodingMode()}{encoding mode}.
\since 1.0
*/
void QVideoEncoderSettings::setQuality(QtMultimedia::EncodingQuality quality)
@@ -649,7 +612,6 @@ private:
\brief The QImageEncoderSettings class provides a set of image encoder
settings.
\since 1.0
A image encoder settings object is used to specify the image encoder
settings used by QCameraImageCapture. Image encoder settings are selected
@@ -673,7 +635,6 @@ QImageEncoderSettings::QImageEncoderSettings()
/*!
Constructs a copy of the image encoder settings object \a other.
\since 1.0
*/
QImageEncoderSettings::QImageEncoderSettings(const QImageEncoderSettings& other)
@@ -691,7 +652,6 @@ QImageEncoderSettings::~QImageEncoderSettings()
/*!
Assigns the value of \a other to a image encoder settings object.
\since 1.0
*/
QImageEncoderSettings &QImageEncoderSettings::operator=(const QImageEncoderSettings &other)
{
@@ -705,7 +665,6 @@ QImageEncoderSettings &QImageEncoderSettings::operator=(const QImageEncoderSetti
Returns true if the settings objects are of equal value, and false if they
are not of equal value.
\since 1.0
*/
bool QImageEncoderSettings::operator==(const QImageEncoderSettings &other) const
{
@@ -723,7 +682,6 @@ bool QImageEncoderSettings::operator==(const QImageEncoderSettings &other) const
Returns true if the settings objects are not of equal value, and false if
they are of equal value.
\since 1.0
*/
bool QImageEncoderSettings::operator!=(const QImageEncoderSettings &other) const
{
@@ -734,7 +692,6 @@ bool QImageEncoderSettings::operator!=(const QImageEncoderSettings &other) const
Identifies if a image encoder settings object is uninitalized.
Returns true if the settings are null, and false if they are not.
\since 1.0
*/
bool QImageEncoderSettings::isNull() const
{
@@ -743,7 +700,6 @@ bool QImageEncoderSettings::isNull() const
/*!
Returns the image codec.
\since 1.0
*/
QString QImageEncoderSettings::codec() const
@@ -753,7 +709,6 @@ QString QImageEncoderSettings::codec() const
/*!
Sets the image \a codec.
\since 1.0
*/
void QImageEncoderSettings::setCodec(const QString& codec)
{
@@ -763,7 +718,6 @@ void QImageEncoderSettings::setCodec(const QString& codec)
/*!
Returns the resolution of the encoded image.
\since 1.0
*/
QSize QImageEncoderSettings::resolution() const
@@ -776,7 +730,6 @@ QSize QImageEncoderSettings::resolution() const
An empty QSize indicates the encoder should make an optimal choice based on
what is available from the image source and the limitations of the codec.
\since 1.0
*/
void QImageEncoderSettings::setResolution(const QSize &resolution)
@@ -789,7 +742,6 @@ void QImageEncoderSettings::setResolution(const QSize &resolution)
Sets the \a width and \a height of the resolution of the encoded image.
\overload
\since 1.0
*/
void QImageEncoderSettings::setResolution(int width, int height)
@@ -800,7 +752,6 @@ void QImageEncoderSettings::setResolution(int width, int height)
/*!
Returns the image encoding quality.
\since 1.0
*/
QtMultimedia::EncodingQuality QImageEncoderSettings::quality() const
@@ -810,7 +761,6 @@ QtMultimedia::EncodingQuality QImageEncoderSettings::quality() const
/*!
Sets the image encoding \a quality.
\since 1.0
*/
void QImageEncoderSettings::setQuality(QtMultimedia::EncodingQuality quality)