Remove antiquated \since lines in docs.

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

View File

@@ -64,7 +64,6 @@ namespace
/*!
\class QAbstractVideoBuffer
\brief The QAbstractVideoBuffer class is an abstraction for video data.
\since 1.0
\inmodule QtMultimedia
The QVideoFrame class makes use of a QAbstractVideoBuffer internally to reference a buffer of
@@ -150,7 +149,6 @@ QAbstractVideoBuffer::~QAbstractVideoBuffer()
/*!
Returns the type of a video buffer's handle.
\since 1.0
\sa handle()
*/
QAbstractVideoBuffer::HandleType QAbstractVideoBuffer::handleType() const
@@ -163,7 +161,6 @@ QAbstractVideoBuffer::HandleType QAbstractVideoBuffer::handleType() const
Returns the mode a video buffer is mapped in.
\since 1.0
\sa map()
*/
@@ -192,7 +189,6 @@ QAbstractVideoBuffer::HandleType QAbstractVideoBuffer::handleType() const
\note Writing to memory that is mapped as read-only is undefined, and may result in changes
to shared data or crashes.
\since 1.0
\sa unmap(), mapMode()
*/
@@ -204,7 +200,6 @@ QAbstractVideoBuffer::HandleType QAbstractVideoBuffer::handleType() const
If the \l {QAbstractVideoBuffer::MapMode}{MapMode} included the \c QAbstractVideoBuffer::WriteOnly
flag this will write the current content of the mapped memory back to the video frame.
\since 1.0
\sa map()
*/
@@ -213,7 +208,6 @@ QAbstractVideoBuffer::HandleType QAbstractVideoBuffer::handleType() const
The type of the handle is given by handleType() function.
\since 1.0
\sa handleType()
*/
QVariant QAbstractVideoBuffer::handle() const

View File

@@ -81,7 +81,6 @@ public:
/*!
\class QAbstractVideoSurface
\brief The QAbstractVideoSurface class is a base class for video presentation surfaces.
\since 1.0
\inmodule QtMultimedia
The QAbstractVideoSurface class defines the standard interface that video producers use to
@@ -160,14 +159,12 @@ QAbstractVideoSurface::~QAbstractVideoSurface()
that can be mapped in read-only mode.
Types that are first in the list can be assumed to be faster to render.
\since 1.0
*/
/*!
Tests a video surface \a format to determine if a surface can accept it.
Returns true if the format is supported by the surface, and false otherwise.
\since 1.0
*/
bool QAbstractVideoSurface::isFormatSupported(const QVideoSurfaceFormat &format) const
{
@@ -185,7 +182,6 @@ bool QAbstractVideoSurface::isFormatSupported(const QVideoSurfaceFormat &format)
If the format is already supported it will be returned unchanged, or if there is no similar
supported format an invalid format will be returned.
\since 1.0
*/
QVideoSurfaceFormat QAbstractVideoSurface::nearestFormat(const QVideoSurfaceFormat &format) const
{
@@ -199,13 +195,11 @@ QVideoSurfaceFormat QAbstractVideoSurface::nearestFormat(const QVideoSurfaceForm
Signals that the set of formats supported by a video surface has changed.
\since 1.0
\sa supportedPixelFormats(), isFormatSupported()
*/
/*!
Returns the format of a video surface.
\since 1.0
*/
QVideoSurfaceFormat QAbstractVideoSurface::surfaceFormat() const
{
@@ -218,7 +212,6 @@ QVideoSurfaceFormat QAbstractVideoSurface::surfaceFormat() const
Signals that the configured \a format of a video surface has changed.
\since 1.0
\sa surfaceFormat(), start()
*/
@@ -228,7 +221,6 @@ QVideoSurfaceFormat QAbstractVideoSurface::surfaceFormat() const
Returns true if the surface was started, and false if an error occurred.
\note You must call the base class implementation of start() at the end of your implementation.
\since 1.0
\sa isActive(), stop()
*/
bool QAbstractVideoSurface::start(const QVideoSurfaceFormat &format)
@@ -252,7 +244,6 @@ bool QAbstractVideoSurface::start(const QVideoSurfaceFormat &format)
Stops a video surface presenting frames and releases any resources acquired in start().
\note You must call the base class implementation of stop() at the start of your implementation.
\since 1.0
\sa isActive(), start()
*/
void QAbstractVideoSurface::stop()
@@ -271,7 +262,6 @@ void QAbstractVideoSurface::stop()
Indicates whether a video surface has been started.
Returns true if the surface has been started, and false otherwise.
\since 1.0
*/
bool QAbstractVideoSurface::isActive() const
{
@@ -284,7 +274,6 @@ bool QAbstractVideoSurface::isActive() const
Signals that the \a active state of a video surface has changed.
\since 1.0
\sa isActive(), start(), stop()
*/
@@ -306,7 +295,6 @@ bool QAbstractVideoSurface::isActive() const
A video surface must be in the started state for present() to succeed, and the format of the
video frame must be compatible with the current video surface format.
\since 1.0
\sa error()
*/
@@ -315,7 +303,6 @@ bool QAbstractVideoSurface::isActive() const
If a surface fails to start(), or stops unexpectedly this function can be called to discover
what error occurred.
\since 1.0
*/
QAbstractVideoSurface::Error QAbstractVideoSurface::error() const
@@ -329,7 +316,6 @@ QAbstractVideoSurface::Error QAbstractVideoSurface::error() const
This can be called by implementors of this interface to communicate
what the most recent error was.
\since 1.0
*/
void QAbstractVideoSurface::setError(Error error)
{
@@ -345,7 +331,6 @@ void QAbstractVideoSurface::setError(Error error)
can render with optimal quality and/or performance.
The native resolution is not always known and can be changed during playback.
\since 1.1
*/
QSize QAbstractVideoSurface::nativeResolution() const
{
@@ -358,7 +343,6 @@ QSize QAbstractVideoSurface::nativeResolution() const
This function can be called by implementors of this interface to specify
to frame producers what the native resolution of this surface is.
\since 1.1
*/
void QAbstractVideoSurface::setNativeResolution(const QSize &resolution)
{
@@ -374,7 +358,6 @@ void QAbstractVideoSurface::setNativeResolution(const QSize &resolution)
\fn QAbstractVideoSurface::nativeResolutionChanged(const QSize &resolution);
Signals the native \a resolution of video surface has changed.
\since 1.1
*/
#ifndef QT_NO_DEBUG_STREAM

View File

@@ -90,7 +90,6 @@ QMemoryVideoBuffer::~QMemoryVideoBuffer()
/*!
\reimp
\since 1.1
*/
QAbstractVideoBuffer::MapMode QMemoryVideoBuffer::mapMode() const
{
@@ -99,7 +98,6 @@ QAbstractVideoBuffer::MapMode QMemoryVideoBuffer::mapMode() const
/*!
\reimp
\since 1.1
*/
uchar *QMemoryVideoBuffer::map(MapMode mode, int *numBytes, int *bytesPerLine)
{
@@ -122,7 +120,6 @@ uchar *QMemoryVideoBuffer::map(MapMode mode, int *numBytes, int *bytesPerLine)
/*!
\reimp
\since 1.1
*/
void QMemoryVideoBuffer::unmap()
{

View File

@@ -124,7 +124,6 @@ private:
/*!
\class QVideoFrame
\brief The QVideoFrame class represents a frame of video data.
\since 1.0
\inmodule QtMultimedia
A QVideoFrame encapsulates the pixel data of a video frame, and information about the frame.
@@ -309,7 +308,6 @@ QVideoFrame::QVideoFrame()
Constructs a video frame from a \a buffer with the given pixel \a format and \a size in pixels.
\note This doesn't increment the reference count of the video buffer.
\since 1.0
*/
QVideoFrame::QVideoFrame(
QAbstractVideoBuffer *buffer, const QSize &size, PixelFormat format)
@@ -323,7 +321,6 @@ QVideoFrame::QVideoFrame(
The \a bytesPerLine (stride) is the length of each scan line in bytes, and \a bytes is the total
number of bytes that must be allocated for the frame.
\since 1.0
*/
QVideoFrame::QVideoFrame(int bytes, const QSize &size, int bytesPerLine, PixelFormat format)
: d(new QVideoFramePrivate(size, format))
@@ -344,7 +341,6 @@ QVideoFrame::QVideoFrame(int bytes, const QSize &size, int bytesPerLine, PixelFo
\note This will construct an invalid video frame if there is no frame type equivalent to the
image format.
\since 1.0
\sa pixelFormatFromImageFormat()
*/
QVideoFrame::QVideoFrame(const QImage &image)
@@ -359,7 +355,6 @@ QVideoFrame::QVideoFrame(const QImage &image)
Constructs a shallow copy of \a other. Since QVideoFrame is
explicitly shared, these two instances will reflect the same frame.
\since 1.0
*/
QVideoFrame::QVideoFrame(const QVideoFrame &other)
: d(other.d)
@@ -370,7 +365,6 @@ QVideoFrame::QVideoFrame(const QVideoFrame &other)
Assigns the contents of \a other to this video frame. Since QVideoFrame is
explicitly shared, these two instances will reflect the same frame.
\since 1.0
*/
QVideoFrame &QVideoFrame::operator =(const QVideoFrame &other)
{
@@ -392,7 +386,6 @@ QVideoFrame::~QVideoFrame()
An invalid frame has no video buffer associated with it.
Returns true if the frame is valid, and false if it is not.
\since 1.0
*/
bool QVideoFrame::isValid() const
{
@@ -401,7 +394,6 @@ bool QVideoFrame::isValid() const
/*!
Returns the color format of a video frame.
\since 1.0
*/
QVideoFrame::PixelFormat QVideoFrame::pixelFormat() const
{
@@ -411,7 +403,6 @@ QVideoFrame::PixelFormat QVideoFrame::pixelFormat() const
/*!
Returns the type of a video frame's handle.
\since 1.0
*/
QAbstractVideoBuffer::HandleType QVideoFrame::handleType() const
{
@@ -420,7 +411,6 @@ QAbstractVideoBuffer::HandleType QVideoFrame::handleType() const
/*!
Returns the dimensions of a video frame.
\since 1.0
*/
QSize QVideoFrame::size() const
{
@@ -429,7 +419,6 @@ QSize QVideoFrame::size() const
/*!
Returns the width of a video frame.
\since 1.0
*/
int QVideoFrame::width() const
{
@@ -438,7 +427,6 @@ int QVideoFrame::width() const
/*!
Returns the height of a video frame.
\since 1.0
*/
int QVideoFrame::height() const
{
@@ -449,7 +437,6 @@ int QVideoFrame::height() const
Returns the field an interlaced video frame belongs to.
If the video is not interlaced this will return WholeFrame.
\since 1.0
*/
QVideoFrame::FieldType QVideoFrame::fieldType() const
{
@@ -458,7 +445,6 @@ QVideoFrame::FieldType QVideoFrame::fieldType() const
/*!
Sets the \a field an interlaced video frame belongs to.
\since 1.0
*/
void QVideoFrame::setFieldType(QVideoFrame::FieldType field)
{
@@ -474,7 +460,6 @@ void QVideoFrame::setFieldType(QVideoFrame::FieldType field)
Returns true if the contents of the video frame are mapped to system memory, and false
otherwise.
\since 1.0
\sa mapMode(), QAbstractVideoBuffer::MapMode
*/
@@ -495,7 +480,6 @@ bool QVideoFrame::isMapped() const
Depending on the buffer implementation the changes may be persisted, or worse alter a shared
buffer.
\since 1.0
\sa mapMode(), QAbstractVideoBuffer::MapMode
*/
bool QVideoFrame::isWritable() const
@@ -512,7 +496,6 @@ bool QVideoFrame::isWritable() const
Returns true if the contents of the mapped memory were read from the video frame, and false
otherwise.
\since 1.0
\sa mapMode(), QAbstractVideoBuffer::MapMode
*/
bool QVideoFrame::isReadable() const
@@ -523,7 +506,6 @@ bool QVideoFrame::isReadable() const
/*!
Returns the mode a video frame was mapped to system memory in.
\since 1.0
\sa map(), QAbstractVideoBuffer::MapMode
*/
QAbstractVideoBuffer::MapMode QVideoFrame::mapMode() const
@@ -559,7 +541,6 @@ QAbstractVideoBuffer::MapMode QVideoFrame::mapMode() const
Returns true if the frame was mapped to memory in the given \a mode and false otherwise.
\since 1.0
\sa unmap(), mapMode(), bits()
*/
bool QVideoFrame::map(QAbstractVideoBuffer::MapMode mode)
@@ -605,7 +586,6 @@ bool QVideoFrame::map(QAbstractVideoBuffer::MapMode mode)
unmap() should not be called if map() function failed.
\since 1.0
\sa map()
*/
void QVideoFrame::unmap()
@@ -639,7 +619,6 @@ void QVideoFrame::unmap()
This value is only valid while the frame data is \l {map()}{mapped}.
\since 1.0
\sa bits(), map(), mappedBytes()
*/
int QVideoFrame::bytesPerLine() const
@@ -656,7 +635,6 @@ int QVideoFrame::bytesPerLine() const
are only guaranteed to have been persisted when unmap() is called and when the
buffer has been mapped for writing.
\since 1.0
\sa map(), mappedBytes(), bytesPerLine()
*/
uchar *QVideoFrame::bits()
@@ -672,7 +650,6 @@ uchar *QVideoFrame::bits()
If the buffer was not mapped with read access, the contents of this
buffer will initially be uninitialized.
\since 1.0
\sa map(), mappedBytes(), bytesPerLine()
*/
const uchar *QVideoFrame::bits() const
@@ -685,7 +662,6 @@ const uchar *QVideoFrame::bits() const
This value is only valid while the frame data is \l {map()}{mapped}.
\since 1.0
\sa map()
*/
int QVideoFrame::mappedBytes() const
@@ -698,7 +674,6 @@ int QVideoFrame::mappedBytes() const
For an OpenGL texture this would be the texture ID.
\since 1.0
\sa QAbstractVideoBuffer::handle()
*/
QVariant QVideoFrame::handle() const
@@ -711,7 +686,6 @@ QVariant QVideoFrame::handle() const
An invalid time is represented as -1.
\since 1.0
*/
qint64 QVideoFrame::startTime() const
{
@@ -723,7 +697,6 @@ qint64 QVideoFrame::startTime() const
An invalid time is represented as -1.
\since 1.0
*/
void QVideoFrame::setStartTime(qint64 time)
{
@@ -735,7 +708,6 @@ void QVideoFrame::setStartTime(qint64 time)
An invalid time is represented as -1.
\since 1.0
*/
qint64 QVideoFrame::endTime() const
{
@@ -747,7 +719,6 @@ qint64 QVideoFrame::endTime() const
An invalid time is represented as -1.
\since 1.0
*/
void QVideoFrame::setEndTime(qint64 time)
{
@@ -799,7 +770,6 @@ void QVideoFrame::setMetaData(const QString &key, const QVariant &value)
\note In general \l QImage does not handle YUV formats.
\since 1.0
*/
QVideoFrame::PixelFormat QVideoFrame::pixelFormatFromImageFormat(QImage::Format format)
{
@@ -829,7 +799,6 @@ QVideoFrame::PixelFormat QVideoFrame::pixelFormatFromImageFormat(QImage::Format
\note In general \l QImage does not handle YUV formats.
\since 1.0
*/
QImage::Format QVideoFrame::imageFormatFromPixelFormat(PixelFormat format)
{

View File

@@ -151,7 +151,6 @@ public:
\class QVideoSurfaceFormat
\brief The QVideoSurfaceFormat class specifies the stream format of a video presentation
surface.
\since 1.0
\inmodule QtMultimedia
A video surface presents a stream of video frames. The surface's format describes the type of
@@ -223,7 +222,6 @@ QVideoSurfaceFormat::QVideoSurfaceFormat()
/*!
Contructs a description of stream which receives stream of \a type buffers with given frame
\a size and pixel \a format.
\since 1.0
*/
QVideoSurfaceFormat::QVideoSurfaceFormat(
const QSize& size, QVideoFrame::PixelFormat format, QAbstractVideoBuffer::HandleType type)
@@ -233,7 +231,6 @@ QVideoSurfaceFormat::QVideoSurfaceFormat(
/*!
Constructs a copy of \a other.
\since 1.0
*/
QVideoSurfaceFormat::QVideoSurfaceFormat(const QVideoSurfaceFormat &other)
: d(other.d)
@@ -242,7 +239,6 @@ QVideoSurfaceFormat::QVideoSurfaceFormat(const QVideoSurfaceFormat &other)
/*!
Assigns the values of \a other to this object.
\since 1.0
*/
QVideoSurfaceFormat &QVideoSurfaceFormat::operator =(const QVideoSurfaceFormat &other)
{
@@ -262,7 +258,6 @@ QVideoSurfaceFormat::~QVideoSurfaceFormat()
Identifies if a video surface format has a valid pixel format and frame size.
Returns true if the format is valid, and false otherwise.
\since 1.0
*/
bool QVideoSurfaceFormat::isValid() const
{
@@ -271,7 +266,6 @@ bool QVideoSurfaceFormat::isValid() const
/*!
Returns true if \a other is the same as this video format, and false if they are different.
\since 1.0
*/
bool QVideoSurfaceFormat::operator ==(const QVideoSurfaceFormat &other) const
{
@@ -280,7 +274,6 @@ bool QVideoSurfaceFormat::operator ==(const QVideoSurfaceFormat &other) const
/*!
Returns true if \a other is different to this video format, and false if they are the same.
\since 1.0
*/
bool QVideoSurfaceFormat::operator !=(const QVideoSurfaceFormat &other) const
{
@@ -289,7 +282,6 @@ bool QVideoSurfaceFormat::operator !=(const QVideoSurfaceFormat &other) const
/*!
Returns the pixel format of frames in a video stream.
\since 1.0
*/
QVideoFrame::PixelFormat QVideoSurfaceFormat::pixelFormat() const
{
@@ -303,7 +295,6 @@ QVideoFrame::PixelFormat QVideoSurfaceFormat::pixelFormat() const
provided they can be \l {QAbstractVideoBuffer::map()}{mapped} with the
QAbstractVideoBuffer::ReadOnly flag. If the handleType() is not QAbstractVideoBuffer::NoHandle
then the handle type of the buffer must be the same as that of the surface format.
\since 1.0
*/
QAbstractVideoBuffer::HandleType QVideoSurfaceFormat::handleType() const
{
@@ -314,7 +305,6 @@ QAbstractVideoBuffer::HandleType QVideoSurfaceFormat::handleType() const
Returns the dimensions of frames in a video stream.
\sa frameWidth(), frameHeight()
\since 1.0
*/
QSize QVideoSurfaceFormat::frameSize() const
{
@@ -325,7 +315,6 @@ QSize QVideoSurfaceFormat::frameSize() const
Returns the width of frames in a video stream.
\sa frameSize(), frameHeight()
\since 1.0
*/
int QVideoSurfaceFormat::frameWidth() const
{
@@ -334,7 +323,6 @@ int QVideoSurfaceFormat::frameWidth() const
/*!
Returns the height of frame in a video stream.
\since 1.0
*/
int QVideoSurfaceFormat::frameHeight() const
{
@@ -345,7 +333,6 @@ int QVideoSurfaceFormat::frameHeight() const
Sets the size of frames in a video stream to \a size.
This will reset the viewport() to fill the entire frame.
\since 1.0
*/
void QVideoSurfaceFormat::setFrameSize(const QSize &size)
{
@@ -359,7 +346,6 @@ void QVideoSurfaceFormat::setFrameSize(const QSize &size)
Sets the \a width and \a height of frames in a video stream.
This will reset the viewport() to fill the entire frame.
\since 1.0
*/
void QVideoSurfaceFormat::setFrameSize(int width, int height)
{
@@ -373,7 +359,6 @@ void QVideoSurfaceFormat::setFrameSize(int width, int height)
The viewport is the region of a video frame that is actually displayed.
By default the viewport covers an entire frame.
\since 1.0
*/
QRect QVideoSurfaceFormat::viewport() const
{
@@ -382,7 +367,6 @@ QRect QVideoSurfaceFormat::viewport() const
/*!
Sets the viewport of a video stream to \a viewport.
\since 1.0
*/
void QVideoSurfaceFormat::setViewport(const QRect &viewport)
{
@@ -391,7 +375,6 @@ void QVideoSurfaceFormat::setViewport(const QRect &viewport)
/*!
Returns the direction of scan lines.
\since 1.0
*/
QVideoSurfaceFormat::Direction QVideoSurfaceFormat::scanLineDirection() const
{
@@ -400,7 +383,6 @@ QVideoSurfaceFormat::Direction QVideoSurfaceFormat::scanLineDirection() const
/*!
Sets the \a direction of scan lines.
\since 1.0
*/
void QVideoSurfaceFormat::setScanLineDirection(Direction direction)
{
@@ -409,7 +391,6 @@ void QVideoSurfaceFormat::setScanLineDirection(Direction direction)
/*!
Returns the frame rate of a video stream in frames per second.
\since 1.0
*/
qreal QVideoSurfaceFormat::frameRate() const
{
@@ -418,7 +399,6 @@ qreal QVideoSurfaceFormat::frameRate() const
/*!
Sets the frame \a rate of a video stream in frames per second.
\since 1.0
*/
void QVideoSurfaceFormat::setFrameRate(qreal rate)
{
@@ -427,7 +407,6 @@ void QVideoSurfaceFormat::setFrameRate(qreal rate)
/*!
Returns a video stream's pixel aspect ratio.
\since 1.0
*/
QSize QVideoSurfaceFormat::pixelAspectRatio() const
{
@@ -436,7 +415,6 @@ QSize QVideoSurfaceFormat::pixelAspectRatio() const
/*!
Sets a video stream's pixel aspect \a ratio.
\since 1.0
*/
void QVideoSurfaceFormat::setPixelAspectRatio(const QSize &ratio)
{
@@ -447,7 +425,6 @@ void QVideoSurfaceFormat::setPixelAspectRatio(const QSize &ratio)
\overload
Sets the \a horizontal and \a vertical elements of a video stream's pixel aspect ratio.
\since 1.0
*/
void QVideoSurfaceFormat::setPixelAspectRatio(int horizontal, int vertical)
{
@@ -456,7 +433,6 @@ void QVideoSurfaceFormat::setPixelAspectRatio(int horizontal, int vertical)
/*!
Returns the Y'CbCr color space of a video stream.
\since 1.0
*/
QVideoSurfaceFormat::YCbCrColorSpace QVideoSurfaceFormat::yCbCrColorSpace() const
{
@@ -466,7 +442,6 @@ QVideoSurfaceFormat::YCbCrColorSpace QVideoSurfaceFormat::yCbCrColorSpace() cons
/*!
Sets the Y'CbCr color \a space of a video stream.
It is only used with raw YUV frame types.
\since 1.0
*/
void QVideoSurfaceFormat::setYCbCrColorSpace(QVideoSurfaceFormat::YCbCrColorSpace space)
{
@@ -477,7 +452,6 @@ void QVideoSurfaceFormat::setYCbCrColorSpace(QVideoSurfaceFormat::YCbCrColorSpac
Returns a suggested size in pixels for the video stream.
This is the size of the viewport scaled according to the pixel aspect ratio.
\since 1.0
*/
QSize QVideoSurfaceFormat::sizeHint() const
{
@@ -491,7 +465,6 @@ QSize QVideoSurfaceFormat::sizeHint() const
/*!
Returns a list of video format dynamic property names.
\since 1.0
*/
QList<QByteArray> QVideoSurfaceFormat::propertyNames() const
{
@@ -511,7 +484,6 @@ QList<QByteArray> QVideoSurfaceFormat::propertyNames() const
/*!
Returns the value of the video format's \a name property.
\since 1.0
*/
QVariant QVideoSurfaceFormat::property(const char *name) const
{
@@ -552,7 +524,6 @@ QVariant QVideoSurfaceFormat::property(const char *name) const
Trying to set a read only property will be ignored.
\since 1.0
*/
void QVideoSurfaceFormat::setProperty(const char *name, const QVariant &value)
{