From 91ae6f5e9408fdccba509a9af21127ee8a54a07b Mon Sep 17 00:00:00 2001 From: Michael Goddard Date: Thu, 22 Sep 2011 15:03:51 +1000 Subject: Clean some doc warnings. Change-Id: I9cadc589a02bbc4804d2d21ab30752af375ef89c Reviewed-on: http://codereview.qt-project.org/5348 Reviewed-by: Qt Sanity Bot Reviewed-by: Ling Hu --- doc/src/camera.qdoc | 7 ------- doc/src/multimedia.qdoc | 9 --------- src/multimediakit/audio/qaudiodeviceinfo.cpp | 2 -- src/multimediakit/audio/qaudioinput.cpp | 6 ------ src/multimediakit/audio/qaudiooutput.cpp | 10 +--------- src/multimediakit/qaudioendpointselector.cpp | 2 -- src/multimediakit/qcameraflashcontrol.cpp | 2 -- src/multimediakit/qmediacontrol.cpp | 2 -- src/multimediakit/qmediaobject.cpp | 4 ---- src/multimediakit/video/qabstractvideobuffer.cpp | 6 ------ src/multimediakit/video/qabstractvideosurface.cpp | 4 ---- src/multimediakit/video/qvideoframe.cpp | 17 ----------------- src/multimediakit/video/qvideosurfaceformat.cpp | 3 --- 13 files changed, 1 insertion(+), 73 deletions(-) diff --git a/doc/src/camera.qdoc b/doc/src/camera.qdoc index 5e140be0c..36b8e9a6c 100644 --- a/doc/src/camera.qdoc +++ b/doc/src/camera.qdoc @@ -25,13 +25,6 @@ ** ****************************************************************************/ -// XXX OMG its so bad -// namespace warning -// why mention control? -// bad brief -// control list -// links? - /*! \page camera.html diff --git a/doc/src/multimedia.qdoc b/doc/src/multimedia.qdoc index b8bcc5b82..bc4e2c138 100644 --- a/doc/src/multimedia.qdoc +++ b/doc/src/multimedia.qdoc @@ -32,15 +32,6 @@ APIs to play and record media, and manage a collection of media content. */ -// XXX title sucks -// XXX move backend stuff away -// XXX move QML stuff up -// XXX more introductory material -// XXX terminology -// XXX separate pages for audio, video, camera, radio, metadata -// control, mediaobject etc stuff -// symbian/harmattan specific pages - /*! \page multimedia.html diff --git a/src/multimediakit/audio/qaudiodeviceinfo.cpp b/src/multimediakit/audio/qaudiodeviceinfo.cpp index 4b71b273b..6b6f7951e 100644 --- a/src/multimediakit/audio/qaudiodeviceinfo.cpp +++ b/src/multimediakit/audio/qaudiodeviceinfo.cpp @@ -188,8 +188,6 @@ bool QAudioDeviceInfo::isNull() const Device names vary depending on the platform/audio plugin being used. - XXX - They are a unique string identifier for the audio device. eg. default, Intel, U0x46d0x9a4 diff --git a/src/multimediakit/audio/qaudioinput.cpp b/src/multimediakit/audio/qaudioinput.cpp index bb4f89653..4a6bfaefd 100644 --- a/src/multimediakit/audio/qaudioinput.cpp +++ b/src/multimediakit/audio/qaudioinput.cpp @@ -57,12 +57,6 @@ QT_BEGIN_NAMESPACE \ingroup multimedia \since 1.0 - XXX Needs more blurb about use cases etc - Link to terminology etc - Push/Pull mode - State diagram - - You can construct an audio input with the system's \l{QAudioDeviceInfo::defaultInputDevice()}{default audio input device}. It is also possible to create QAudioInput with a diff --git a/src/multimediakit/audio/qaudiooutput.cpp b/src/multimediakit/audio/qaudiooutput.cpp index 10496bd98..ea9dcb11f 100644 --- a/src/multimediakit/audio/qaudiooutput.cpp +++ b/src/multimediakit/audio/qaudiooutput.cpp @@ -58,8 +58,6 @@ QT_BEGIN_NAMESPACE \ingroup multimedia \since 1.0 - XXX - You can construct an audio output with the system's \l{QAudioDeviceInfo::defaultOutputDevice()}{default audio output device}. It is also possible to create QAudioOutput with a @@ -148,7 +146,7 @@ QAudioOutput::QAudioOutput(const QAudioDeviceInfo &audioDevice, const QAudioForm /*! Destroys this audio output. - XXX This will release any system resources used and free any buffers. + This will release any system resources used and free any buffers. */ QAudioOutput::~QAudioOutput() { @@ -207,7 +205,6 @@ QIODevice* QAudioOutput::start() /*! Stops the audio output, detaching from the system resource. - XXX Sets error() to QAudio::NoError, state() to QAudio::StoppedState and emit stateChanged() signal. \since 1.0 @@ -220,7 +217,6 @@ void QAudioOutput::stop() /*! Drops all audio data in the buffers, resets buffers to zero. - XXX what about state \since 1.0 */ void QAudioOutput::reset() @@ -231,8 +227,6 @@ void QAudioOutput::reset() /*! Stops processing audio data, preserving buffered audio data. - XXX - Sets error() to QAudio::NoError, state() to QAudio::SuspendedState and emits stateChanged() signal. \since 1.0 @@ -245,8 +239,6 @@ void QAudioOutput::suspend() /*! Resumes processing audio data after a suspend(). -XXX - Sets error() to QAudio::NoError. Sets state() to QAudio::ActiveState if you previously called start(QIODevice*). Sets state() to QAudio::IdleState if you previously called start(). diff --git a/src/multimediakit/qaudioendpointselector.cpp b/src/multimediakit/qaudioendpointselector.cpp index 9bbe267a3..8f2f28f56 100644 --- a/src/multimediakit/qaudioendpointselector.cpp +++ b/src/multimediakit/qaudioendpointselector.cpp @@ -55,8 +55,6 @@ QT_BEGIN_NAMESPACE endpoints available on a system and allows one to be selected as the audio of a media service. - XXX why do I care - The interface name of QAudioEndpointSelector is \c com.nokia.Qt.QAudioEndpointSelector/1.0 as defined in QAudioEndpointSelector_iid. diff --git a/src/multimediakit/qcameraflashcontrol.cpp b/src/multimediakit/qcameraflashcontrol.cpp index 1633a6481..27bf09a7c 100644 --- a/src/multimediakit/qcameraflashcontrol.cpp +++ b/src/multimediakit/qcameraflashcontrol.cpp @@ -60,8 +60,6 @@ QT_BEGIN_NAMESPACE You can retrieve this control from the camera object in the usual way: - XXX snippet for retrieving control - Some camera devices may not have flash hardware, or may not be configurable. In that case, there will be no QCameraFlashControl available. diff --git a/src/multimediakit/qmediacontrol.cpp b/src/multimediakit/qmediacontrol.cpp index b47d694c1..b7dfb3dc5 100644 --- a/src/multimediakit/qmediacontrol.cpp +++ b/src/multimediakit/qmediacontrol.cpp @@ -63,8 +63,6 @@ QT_BEGIN_NAMESPACE the core functionality of the service and a number of optional controls which expose any additional functionality. - XXX concrete example of this relationship - A pointer to a control implemented by a media service can be obtained using the \l {QMediaService::requestControl()} member of QMediaService. If the service doesn't implement a control it will instead return a null pointer. diff --git a/src/multimediakit/qmediaobject.cpp b/src/multimediakit/qmediaobject.cpp index 3276a2b44..2f6840e04 100644 --- a/src/multimediakit/qmediaobject.cpp +++ b/src/multimediakit/qmediaobject.cpp @@ -74,8 +74,6 @@ void QMediaObjectPrivate::_q_notify() \ingroup multimedia \since 1.0 - XXX why do I care - QMediaObject derived classes provide access to the functionality of a QMediaService. Each media object hosts a QMediaService and uses the QMediaControl interfaces implemented by the service to implement its @@ -156,8 +154,6 @@ void QMediaObject::setNotifyInterval(int milliSeconds) that wrap this functionality, so this function rarely needs to be called directly. - XXX for example - The object passed must implement the QMediaBindableInterface interface. \since 1.0 diff --git a/src/multimediakit/video/qabstractvideobuffer.cpp b/src/multimediakit/video/qabstractvideobuffer.cpp index 8704e40fc..88c00f6a5 100644 --- a/src/multimediakit/video/qabstractvideobuffer.cpp +++ b/src/multimediakit/video/qabstractvideobuffer.cpp @@ -55,8 +55,6 @@ QT_BEGIN_NAMESPACE video data. Creating a subclass of QAbstractVideoBuffer will allow you to construct video frames from preallocated or static buffers. - XXX where do these come from? - The contents of a buffer can be accessed by mapping the buffer to memory using the map() function which returns a pointer to memory containing the contents of the the video buffer. The memory returned by map() is released by calling the unmap() function. @@ -64,8 +62,6 @@ QT_BEGIN_NAMESPACE The handle() of a buffer may also be used to manipulate its contents using type specific APIs. The type of a buffer's handle is given by the handleType() function. - XXX example of handle stuff (opengl etc) - \sa QVideoFrame */ @@ -194,8 +190,6 @@ QAbstractVideoBuffer::HandleType QAbstractVideoBuffer::handleType() const The type of the handle is given by handleType() function. - XXX put a table here too - \since 1.0 \sa handleType() */ diff --git a/src/multimediakit/video/qabstractvideosurface.cpp b/src/multimediakit/video/qabstractvideosurface.cpp index 13c2b25de..62a8acf57 100644 --- a/src/multimediakit/video/qabstractvideosurface.cpp +++ b/src/multimediakit/video/qabstractvideosurface.cpp @@ -61,8 +61,6 @@ Q_DECLARE_METATYPE(QAbstractVideoSurface::Error) A video surface presents a continuous stream of identically formatted frames, where the format of each frame is compatible with a stream format supplied when starting a presentation. - XXX Why do I carE? - The QAbstractVideoSurface class defines the standard interface that video producers use to inter-operate with video presentation surfaces. It is not supposed to be instantiated directly. Instead, you should subclass it to create new video surfaces. @@ -78,8 +76,6 @@ Q_DECLARE_METATYPE(QAbstractVideoSurface::Error) hold a reference to the buffer of a presented video frame until a new frame is presented or streaming is stopped. The stop() function will disable a surface and a release any video buffers it holds references to. - - XXX Example? */ /*! diff --git a/src/multimediakit/video/qvideoframe.cpp b/src/multimediakit/video/qvideoframe.cpp index 9286f898f..7c6bbdb11 100644 --- a/src/multimediakit/video/qvideoframe.cpp +++ b/src/multimediakit/video/qvideoframe.cpp @@ -120,8 +120,6 @@ private: A QVideoFrame encapsulates the data of a video frame, and information about the frame. - XXX why do I care - The contents of a video frame can be mapped to memory using the map() function. While mapped, the video data can accessed using the bits() function, which returns a pointer to a buffer. The total size of this buffer is given by the mappedBytes() function, and the size of each line is given @@ -133,8 +131,6 @@ private: \note QVideoFrame is explicitly shared, any change made to video frame will also apply to any copies. - - XXX example */ /*! @@ -343,8 +339,6 @@ QVideoFrame::QVideoFrame(const QImage &image) /*! Constructs a copy of \a other. - XXX reference count - \since 1.0 */ QVideoFrame::QVideoFrame(const QVideoFrame &other) @@ -365,8 +359,6 @@ QVideoFrame &QVideoFrame::operator =(const QVideoFrame &other) /*! Destroys a video frame. - - XXX reference count */ QVideoFrame::~QVideoFrame() { @@ -397,8 +389,6 @@ QVideoFrame::PixelFormat QVideoFrame::pixelFormat() const /*! Returns the type of a video frame's handle. - XXX What about it? - \since 1.0 */ QAbstractVideoBuffer::HandleType QVideoFrame::handleType() const @@ -536,8 +526,6 @@ QAbstractVideoBuffer::MapMode QVideoFrame::mapMode() const Returns true if the buffer was mapped to memory in the given \a mode and false otherwise. - XXX examples and why do I care - \since 1.0 \sa unmap(), mapMode(), bits() */ @@ -581,8 +569,6 @@ void QVideoFrame::unmap() \note This is the bytes per line of the first plane only. The bytes per line of subsequent planes should be calculated as per the frame type. - XXX examples of these calculations - This value is only valid while the frame data is \l {map()}{mapped}. \since 1.0 @@ -643,8 +629,6 @@ int QVideoFrame::mappedBytes() const For an OpenGL texture this would be the texture ID. - XXX Perhaps a table with corresondence - \since 1.0 \sa QAbstractVideoBuffer::handle() */ @@ -674,7 +658,6 @@ void QVideoFrame::setStartTime(qint64 time) /*! Returns the presentation time when a frame should stop being displayed. - XXX example? if start=end what happens? \since 1.0 */ qint64 QVideoFrame::endTime() const diff --git a/src/multimediakit/video/qvideosurfaceformat.cpp b/src/multimediakit/video/qvideosurfaceformat.cpp index da27b5f41..4d198e186 100644 --- a/src/multimediakit/video/qvideosurfaceformat.cpp +++ b/src/multimediakit/video/qvideosurfaceformat.cpp @@ -142,9 +142,6 @@ public: A video surface presents a stream of video frames. The surface's format describes the type of the frames and determines how they should be presented. - XXX Why do I care - XXX why isn't it videostreamformat then? - The core properties of a video stream required to setup a video surface are the pixel format given by pixelFormat(), and the frame dimensions given by frameSize(). -- cgit v1.2.3