Fix some qdoc warnings.

qtbase/src/corelib/io/qdebug.cpp:698: warning: Class QDebugStateSaver has no \inmodule command; using project name by default: QtCore
qtbase/src/gui/opengl/qopenglframebufferobject.cpp:1138: warning: Can't link to 'takeTextures()'
qtbase/src/gui/opengl/qopenglframebufferobject.cpp:1159: warning: Can't link to 'takeTextures()'
qtbase/src/gui/opengl/qopenglframebufferobject.cpp:953: warning: No such parameter 'height' in QOpenGLFramebufferObject::addColorAttachment()
qtbase/src/gui/opengl/qopenglframebufferobject.cpp:953: warning: No such parameter 'width' in QOpenGLFramebufferObject::addColorAttachment()
qtbase/src/gui/opengl/qopenglframebufferobject.cpp:953: warning: Undocumented parameter 'size' in QOpenGLFramebufferObject::addColorAttachment()
qtbase/src/gui/painting/qpaintdevice.qdoc:80: warning: Undocumented enum item 'PdmDevicePixelRatioScaled' in QPaintDevice::PaintDeviceMetric
qtbase/src/testlib/qbenchmarkmetric.cpp:154: warning: Invalid use of '\relates' (already a member of 'QTest')
qtbase/src/testlib/qbenchmarkmetric.cpp:81: warning: Invalid use of '\relates' (already a member of 'QTest')
qtbase/src/widgets/dialogs/qdialog.cpp:152: warning: Can't link to 'QCloseEvent::ignore()'
qtbase/src/widgets/dialogs/qdialog.cpp:557: warning: Can't link to 'QApplication::quit()'
qtbase/src/widgets/kernel/qwidget.cpp:8326: warning: Can't link to 'QCloseEvent::accept()'
qtbase/src/widgets/kernel/qwidget.cpp:8326: warning: Can't link to 'QCloseEvent::ignore()'
qtbase/src/widgets/kernel/qwidget.cpp:9300: warning: Can't link to 'QWheelEvent::accept()'
qtbase/src/widgets/kernel/qwidget.cpp:9300: warning: Can't link to 'QWheelEvent::ignore()'
qtbase/src/widgets/kernel/qwidget.cpp:9321: warning: Can't link to 'QTabletEvent::accept()'
qtbase/src/widgets/kernel/qwidget.cpp:9321: warning: Can't link to 'QTabletEvent::ignore()'
qtbase/src/widgets/kernel/qwidget.cpp:9373: warning: Can't link to 'QKeyEvent::ignore()'

Change-Id: I97ae85398181645c1054c303e5c8a87deb619409
Reviewed-by: Martin Smith <martin.smith@digia.com>
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
This commit is contained in:
Friedemann Kleint 2015-09-04 16:20:54 +02:00
parent ae50ee8adf
commit 4bbdfaa8ff
7 changed files with 22 additions and 18 deletions

View File

@ -697,7 +697,7 @@ QDebug &QDebug::resetFormat()
/*!
\class QDebugStateSaver
\inmodule QtCore
\brief Convenience class for custom QDebug operators
Saves the settings used by QDebug, and restores them upon destruction,

View File

@ -951,8 +951,8 @@ QOpenGLFramebufferObject::~QOpenGLFramebufferObject()
}
/*!
Creates and attaches an additional texture or renderbuffer of size \a width
and \a height.
Creates and attaches an additional texture or renderbuffer of \a size width
and height.
There is always an attachment at GL_COLOR_ATTACHMENT0. Call this function
to set up additional attachments at GL_COLOR_ATTACHMENT1,
@ -1142,7 +1142,7 @@ GLuint QOpenGLFramebufferObject::texture() const
\since 5.6
\sa takeTextures(), texture()
\sa takeTexture(), texture()
*/
QVector<GLuint> QOpenGLFramebufferObject::textures() const
{
@ -1172,7 +1172,7 @@ QVector<GLuint> QOpenGLFramebufferObject::textures() const
\since 5.3
\sa texture(), bind(), release(), takeTextures()
\sa texture(), bind(), release()
*/
GLuint QOpenGLFramebufferObject::takeTexture()
{

View File

@ -118,7 +118,13 @@
values are 1 for normal-dpi displays and 2 for high-dpi "retina"
displays.
\sa metric()
\value PdmDevicePixelRatioScaled The scaled device pixel ratio for the device.
This is identical to PdmDevicePixelRatio, except that the value is scaled by a
constant factor in order to support paint devices with fractional scale factors.
The constant scaling factor used is devicePixelRatioFScale(). This enum value
has been introduced in Qt 5.6.
\sa metric(), devicePixelRatioF()
*/
/*!

View File

@ -79,7 +79,6 @@
*/
/*!
\relates QTest
\since 4.7
Returns the enum value \a metric as a character string.
*/
@ -152,7 +151,6 @@ const char * QTest::benchmarkMetricName(QBenchmarkMetric metric)
};
/*!
\relates QTest
\since 4.7
Retuns the units of measure for the specified \a metric.
*/

View File

@ -243,7 +243,7 @@ void QDialogPrivate::deletePlatformHelper()
\section1 Escape Key
If the user presses the Esc key in a dialog, QDialog::reject()
will be called. This will cause the window to close: The \l{QCloseEvent}{close event} cannot be \l{QCloseEvent::ignore()}{ignored}.
will be called. This will cause the window to close: The \l{QCloseEvent}{close event} cannot be \l{QEvent::ignore()}{ignored}.
\section1 Extensibility
@ -565,7 +565,7 @@ int QDialog::exec()
last window closed, the QApplication::lastWindowClosed() signal is
emitted.
\sa accept(), reject(), QApplication::activeWindow(), QApplication::quit()
\sa accept(), reject(), QApplication::activeWindow(), QCoreApplication::quit()
*/
void QDialog::done(int r)

View File

@ -8328,8 +8328,8 @@ bool QWidgetPrivate::close_helper(CloseMode mode)
otherwise returns \c false.
First it sends the widget a QCloseEvent. The widget is
\l{hide()}{hidden} if it \l{QCloseEvent::accept()}{accepts}
the close event. If it \l{QCloseEvent::ignore()}{ignores}
\l{hide()}{hidden} if it \l{QEvent::accept()}{accepts}
the close event. If it \l{QEvent::ignore()}{ignores}
the event, nothing happens. The default
implementation of QWidget::closeEvent() accepts the close event.
@ -9302,12 +9302,12 @@ void QWidget::mouseDoubleClickEvent(QMouseEvent *event)
subclass to receive wheel events for the widget.
If you reimplement this handler, it is very important that you
\l{QWheelEvent}{ignore()} the event if you do not handle
\l{QEvent}{ignore()} the event if you do not handle
it, so that the widget's parent can interpret it.
The default implementation ignores the event.
\sa QWheelEvent::ignore(), QWheelEvent::accept(), event(),
\sa QEvent::ignore(), QEvent::accept(), event(),
QWheelEvent
*/
@ -9323,12 +9323,12 @@ void QWidget::wheelEvent(QWheelEvent *event)
subclass to receive tablet events for the widget.
If you reimplement this handler, it is very important that you
\l{QTabletEvent}{ignore()} the event if you do not handle
\l{QEvent}{ignore()} the event if you do not handle
it, so that the widget's parent can interpret it.
The default implementation ignores the event.
\sa QTabletEvent::ignore(), QTabletEvent::accept(), event(),
\sa QEvent::ignore(), QEvent::accept(), event(),
QTabletEvent
*/
@ -9388,7 +9388,7 @@ void QWidget::keyPressEvent(QKeyEvent *event)
need to call QKeyEvent::accept() - just do not call the base class
implementation if you act upon the key.
\sa keyPressEvent(), QKeyEvent::ignore(), setFocusPolicy(),
\sa keyPressEvent(), QEvent::ignore(), setFocusPolicy(),
focusInEvent(), focusOutEvent(), event(), QKeyEvent
*/

View File

@ -638,7 +638,7 @@ void QMenuBar::initStyleOption(QStyleOptionMenuItem *option, const QAction *acti
\row \li quit or exit
\li Application Menu | Quit <application name>
\li If this entry is not found a default Quit item will be
created to call QApplication::quit()
created to call QCoreApplication::quit()
\endtable
You can override this behavior by using the QAction::menuRole()