diff options
author | Marius Storm-Olsen <marius.storm-olsen@nokia.com> | 2012-05-10 13:10:23 +0200 |
---|---|---|
committer | Qt by Nokia <qt-info@nokia.com> | 2012-05-11 01:42:02 +0200 |
commit | ad97aba452ed7d3dbd3c9d437c59c14b2ae0661b (patch) | |
tree | 2a37426bc8e29f27d3b3a486693b484b2caa069c /src/gui/kernel | |
parent | 87d21127de4a361c7e76ba91a0ea336bbed32853 (diff) |
Doc: Fix \sa usage
Ensure comma between elements (757 missing), single space and curly-
braces around title elements, etc.
Change-Id: Id16c3fda7fc47a12a0682f8720214f4990609a97
Reviewed-by: Giuseppe D'Angelo <giuseppe.dangelo@kdab.com>
Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
Diffstat (limited to 'src/gui/kernel')
-rw-r--r-- | src/gui/kernel/qclipboard.cpp | 8 | ||||
-rw-r--r-- | src/gui/kernel/qevent.cpp | 67 | ||||
-rw-r--r-- | src/gui/kernel/qkeysequence.cpp | 8 | ||||
-rw-r--r-- | src/gui/kernel/qpalette.cpp | 56 | ||||
-rw-r--r-- | src/gui/kernel/qplatformintegration_qpa.cpp | 4 | ||||
-rw-r--r-- | src/gui/kernel/qshortcutmap.cpp | 2 |
6 files changed, 73 insertions, 72 deletions
diff --git a/src/gui/kernel/qclipboard.cpp b/src/gui/kernel/qclipboard.cpp index 90fd63ee62..3ac7fbbd37 100644 --- a/src/gui/kernel/qclipboard.cpp +++ b/src/gui/kernel/qclipboard.cpp @@ -345,7 +345,7 @@ void QClipboard::setText(const QString &text, Mode mode) QClipboard::Selection, the image is retrieved from the global mouse selection. - \sa setImage() pixmap() mimeData(), QImage::isNull() + \sa setImage(), pixmap(), mimeData(), QImage::isNull() */ QImage QClipboard::image(Mode mode) const { @@ -368,7 +368,7 @@ QImage QClipboard::image(Mode mode) const \snippet code/src_gui_kernel_qclipboard.cpp 1 - \sa image(), setPixmap() setMimeData() + \sa image(), setPixmap(), setMimeData() */ void QClipboard::setImage(const QImage &image, Mode mode) { @@ -390,7 +390,7 @@ void QClipboard::setImage(const QImage &image, Mode mode) QClipboard::Selection, the pixmap is retrieved from the global mouse selection. - \sa setPixmap() image() mimeData() QPixmap::convertFromImage() + \sa setPixmap(), image(), mimeData(), QPixmap::convertFromImage() */ QPixmap QClipboard::pixmap(Mode mode) const { @@ -409,7 +409,7 @@ QPixmap QClipboard::pixmap(Mode mode) const QClipboard::Selection, the pixmap is stored in the global mouse selection. - \sa pixmap() setImage() setMimeData() + \sa pixmap(), setImage(), setMimeData() */ void QClipboard::setPixmap(const QPixmap &pixmap, Mode mode) { diff --git a/src/gui/kernel/qevent.cpp b/src/gui/kernel/qevent.cpp index eeedd32fd9..beb75308b3 100644 --- a/src/gui/kernel/qevent.cpp +++ b/src/gui/kernel/qevent.cpp @@ -135,7 +135,7 @@ QInputEvent::~QInputEvent() and QWidget::mouseMoveEvent() to receive mouse events in your own widgets. - \sa QWidget::setMouseTracking() QWidget::grabMouse() + \sa QWidget::setMouseTracking(), QWidget::grabMouse(), QCursor::pos() */ @@ -234,7 +234,7 @@ QMouseEvent::~QMouseEvent() screen position returned by screenPos() to avoid a shaking motion. - \sa x() y() windowPos() screenPos() + \sa x(), y(), windowPos(), screenPos() */ /*! @@ -249,7 +249,7 @@ QMouseEvent::~QMouseEvent() global position returned by globalPos() to avoid a shaking motion. - \sa x() y() pos() localPos() screenPos() + \sa x(), y(), pos(), localPos(), screenPos() */ /*! @@ -260,7 +260,7 @@ QMouseEvent::~QMouseEvent() Returns the position of the mouse cursor as a QPointF, relative to the screen that received the event. - \sa x() y() pos() localPos() screenPos() + \sa x(), y(), pos(), localPos(), screenPos() */ /*! @@ -273,7 +273,7 @@ QMouseEvent::~QMouseEvent() global position returned by globalPos() to avoid a shaking motion. - \sa x() y() globalPos() + \sa x(), y(), globalPos() */ /*! @@ -286,7 +286,7 @@ QMouseEvent::~QMouseEvent() pointer position QCursor::pos(), and from QWidget::mapToGlobal(pos()). - \sa globalX() globalY() + \sa globalX(), globalY() */ /*! @@ -295,7 +295,7 @@ QMouseEvent::~QMouseEvent() Returns the x position of the mouse cursor, relative to the widget that received the event. - \sa y() pos() + \sa y(), pos() */ /*! @@ -304,7 +304,7 @@ QMouseEvent::~QMouseEvent() Returns the y position of the mouse cursor, relative to the widget that received the event. - \sa x() pos() + \sa x(), pos() */ /*! @@ -313,7 +313,7 @@ QMouseEvent::~QMouseEvent() Returns the global x position of the mouse cursor at the time of the event. - \sa globalY() globalPos() + \sa globalY(), globalPos() */ /*! @@ -322,7 +322,7 @@ QMouseEvent::~QMouseEvent() Returns the global y position of the mouse cursor at the time of the event. - \sa globalX() globalPos() + \sa globalX(), globalPos() */ /*! @@ -333,7 +333,7 @@ QMouseEvent::~QMouseEvent() Note that the returned value is always Qt::NoButton for mouse move events. - \sa buttons() Qt::MouseButton + \sa buttons(), Qt::MouseButton */ /*! @@ -347,7 +347,7 @@ QMouseEvent::~QMouseEvent() event. For mouse release events this excludes the button that caused the event. - \sa button() Qt::MouseButton + \sa button(), Qt::MouseButton */ /*! @@ -473,7 +473,7 @@ QHoverEvent::~QHoverEvent() The event handler QWidget::wheelEvent() receives wheel events. - \sa QMouseEvent QWidget::grabMouse() + \sa QMouseEvent, QWidget::grabMouse() */ /*! @@ -505,7 +505,7 @@ QHoverEvent::~QHoverEvent() \a modifiers holds the keyboard modifier flags at the time of the event, and \a orient holds the wheel's orientation. - \sa pos() pixelDelta() angleDelta() state() + \sa pos(), pixelDelta(), angleDelta(), state() */ #ifndef QT_NO_WHEELEVENT QWheelEvent::QWheelEvent(const QPointF &pos, int delta, @@ -536,7 +536,7 @@ QWheelEvent::~QWheelEvent() \a orient holds the wheel's orientation. - \sa pos() pixelDelta() angleDelta() state() + \sa pos(), pixelDelta(), angleDelta(), state() */ QWheelEvent::QWheelEvent(const QPointF &pos, const QPointF& globalPos, int delta, Qt::MouseButtons buttons, Qt::KeyboardModifiers modifiers, @@ -559,7 +559,7 @@ QWheelEvent::QWheelEvent(const QPointF &pos, const QPointF& globalPos, int delta \a angleDelta contains the rotation distance, and \a orient holds the wheel's orientation. - \sa pos() globalPos() delta() state() + \sa pos(), globalPos(), delta(), state() */ QWheelEvent::QWheelEvent(const QPointF &pos, const QPointF& globalPos, @@ -622,7 +622,7 @@ QWheelEvent::QWheelEvent(const QPointF &pos, const QPointF& globalPos, If you move your widgets around in response to mouse events, use globalPos() instead of this function. - \sa x() y() globalPos() + \sa x(), y(), globalPos() */ /*! @@ -631,7 +631,7 @@ QWheelEvent::QWheelEvent(const QPointF &pos, const QPointF& globalPos, Returns the x position of the mouse cursor, relative to the widget that received the event. - \sa y() pos() + \sa y(), pos() */ /*! @@ -640,7 +640,7 @@ QWheelEvent::QWheelEvent(const QPointF &pos, const QPointF& globalPos, Returns the y position of the mouse cursor, relative to the widget that received the event. - \sa x() pos() + \sa x(), pos() */ @@ -653,7 +653,7 @@ QWheelEvent::QWheelEvent(const QPointF &pos, const QPointF& globalPos, mouse events, globalPos() can differ a lot from the current cursor position returned by QCursor::pos(). - \sa globalX() globalY() + \sa globalX(), globalY() */ /*! @@ -662,7 +662,7 @@ QWheelEvent::QWheelEvent(const QPointF &pos, const QPointF& globalPos, Returns the global x position of the mouse cursor at the time of the event. - \sa globalY() globalPos() + \sa globalY(), globalPos() */ /*! @@ -671,7 +671,7 @@ QWheelEvent::QWheelEvent(const QPointF &pos, const QPointF& globalPos, Returns the global y position of the mouse cursor at the time of the event. - \sa globalX() globalPos() + \sa globalX(), globalPos() */ /*! @@ -1059,7 +1059,7 @@ QPaintEvent::~QPaintEvent() Returns the rectangle that needs to be updated. - \sa region() QPainter::setClipRect() + \sa region(), QPainter::setClipRect() */ /*! @@ -1067,7 +1067,7 @@ QPaintEvent::~QPaintEvent() Returns the region that needs to be updated. - \sa rect() QPainter::setClipRegion() + \sa rect(), QPainter::setClipRegion() */ @@ -1157,7 +1157,7 @@ QExposeEvent::~QExposeEvent() The event handler QWidget::resizeEvent() receives resize events. - \sa QWidget::resize() QWidget::setGeometry() + \sa QWidget::resize(), QWidget::setGeometry() */ /*! @@ -1907,7 +1907,8 @@ QVariant QInputMethodQueryEvent::value(Qt::InputMethodQuery query) const \a rotation contains the device's rotation in degrees. 4D mice support rotation. If the device does not support rotation, pass 0 here. - \sa pos() globalPos() device() pressure() xTilt() yTilt() uniqueId(), rotation(), tangentialPressure(), z() + \sa pos(), globalPos(), device(), pressure(), xTilt(), yTilt(), uniqueId(), rotation(), + tangentialPressure(), z() */ QTabletEvent::QTabletEvent(Type type, const QPointF &pos, const QPointF &globalPos, @@ -2014,7 +2015,7 @@ QTabletEvent::~QTabletEvent() If you move widgets around in response to mouse events, use globalPos() instead of this function. - \sa x() y() globalPos() + \sa x(), y(), globalPos() */ /*! @@ -2023,7 +2024,7 @@ QTabletEvent::~QTabletEvent() Returns the x position of the device, relative to the widget that received the event. - \sa y() pos() + \sa y(), pos() */ /*! @@ -2032,7 +2033,7 @@ QTabletEvent::~QTabletEvent() Returns the y position of the device, relative to the widget that received the event. - \sa x() pos() + \sa x(), pos() */ /*! @@ -2054,7 +2055,7 @@ QTabletEvent::~QTabletEvent() globalPos() can differ significantly from the current position QCursor::pos(). - \sa globalX() globalY() hiResGlobalPos() + \sa globalX(), globalY(), hiResGlobalPos() */ /*! @@ -2063,7 +2064,7 @@ QTabletEvent::~QTabletEvent() Returns the global x position of the mouse pointer at the time of the event. - \sa globalY() globalPos() hiResGlobalX() + \sa globalY(), globalPos(), hiResGlobalX() */ /*! @@ -2072,7 +2073,7 @@ QTabletEvent::~QTabletEvent() Returns the global y position of the tablet device at the time of the event. - \sa globalX() globalPos() hiResGlobalY() + \sa globalX(), globalPos(), hiResGlobalY() */ /*! @@ -2104,7 +2105,7 @@ QTabletEvent::~QTabletEvent() The high precision coordinates delivered from the tablet expressed. Sub pixeling information is in the fractional part of the QPointF. - \sa globalPos() hiResGlobalX() hiResGlobalY() + \sa globalPos(), hiResGlobalX(), hiResGlobalY() */ /*! diff --git a/src/gui/kernel/qkeysequence.cpp b/src/gui/kernel/qkeysequence.cpp index f94c6d541e..4eeac1a4dd 100644 --- a/src/gui/kernel/qkeysequence.cpp +++ b/src/gui/kernel/qkeysequence.cpp @@ -1593,7 +1593,7 @@ bool QKeySequence::operator==(const QKeySequence &other) const This function is useful in some circumstances, for example if you want to use QKeySequence objects as keys in a QMap. - \sa operator==() operator!=() operator>() operator<=() operator>=() + \sa operator==(), operator!=(), operator>(), operator<=(), operator>=() */ bool QKeySequence::operator< (const QKeySequence &other) const { @@ -1609,7 +1609,7 @@ bool QKeySequence::operator< (const QKeySequence &other) const Returns true if this key sequence is larger than the \a other key sequence; otherwise returns false. - \sa operator==() operator!=() operator<() operator<=() operator>=() + \sa operator==(), operator!=(), operator<(), operator<=(), operator>=() */ /*! @@ -1618,7 +1618,7 @@ bool QKeySequence::operator< (const QKeySequence &other) const Returns true if this key sequence is smaller or equal to the \a other key sequence; otherwise returns false. - \sa operator==() operator!=() operator<() operator>() operator>=() + \sa operator==(), operator!=(), operator<(), operator>(), operator>=() */ /*! @@ -1627,7 +1627,7 @@ bool QKeySequence::operator< (const QKeySequence &other) const Returns true if this key sequence is larger or equal to the \a other key sequence; otherwise returns false. - \sa operator==() operator!=() operator<() operator>() operator<=() + \sa operator==(), operator!=(), operator<(), operator>(), operator<=() */ /*! diff --git a/src/gui/kernel/qpalette.cpp b/src/gui/kernel/qpalette.cpp index cb18b0d22f..71d5427a37 100644 --- a/src/gui/kernel/qpalette.cpp +++ b/src/gui/kernel/qpalette.cpp @@ -97,7 +97,7 @@ static void qt_palette_from_color(QPalette &pal, const QColor &button) Returns the color that has been set for the given color \a role in the current ColorGroup. - \sa brush() ColorRole + \sa brush(), ColorRole */ /*! @@ -108,7 +108,7 @@ static void qt_palette_from_color(QPalette &pal, const QColor &button) Returns the brush that has been set for the given color \a role in the current ColorGroup. - \sa color() setBrush() ColorRole + \sa color(), setBrush(), ColorRole */ /*! @@ -119,7 +119,7 @@ static void qt_palette_from_color(QPalette &pal, const QColor &button) Sets the color used for the given color \a role, in all color groups, to the specified solid \a color. - \sa brush() setColor() ColorRole + \sa brush(), setColor(), ColorRole */ /*! @@ -128,7 +128,7 @@ static void qt_palette_from_color(QPalette &pal, const QColor &button) Sets the brush for the given color \a role to the specified \a brush for all groups in the palette. - \sa brush() setColor() ColorRole + \sa brush(), setColor(), ColorRole */ /*! @@ -144,7 +144,7 @@ static void qt_palette_from_color(QPalette &pal, const QColor &button) Returns the window text (general foreground) brush of the current color group. - \sa ColorRole brush() + \sa ColorRole, brush() */ /*! @@ -152,7 +152,7 @@ static void qt_palette_from_color(QPalette &pal, const QColor &button) Returns the button brush of the current color group. - \sa ColorRole brush() + \sa ColorRole, brush() */ /*! @@ -160,7 +160,7 @@ static void qt_palette_from_color(QPalette &pal, const QColor &button) Returns the light brush of the current color group. - \sa ColorRole brush() + \sa ColorRole, brush() */ /*! @@ -168,7 +168,7 @@ static void qt_palette_from_color(QPalette &pal, const QColor &button) Returns the midlight brush of the current color group. - \sa ColorRole brush() + \sa ColorRole, brush() */ /*! @@ -176,7 +176,7 @@ static void qt_palette_from_color(QPalette &pal, const QColor &button) Returns the dark brush of the current color group. - \sa ColorRole brush() + \sa ColorRole, brush() */ /*! @@ -184,7 +184,7 @@ static void qt_palette_from_color(QPalette &pal, const QColor &button) Returns the mid brush of the current color group. - \sa ColorRole brush() + \sa ColorRole, brush() */ /*! @@ -192,7 +192,7 @@ static void qt_palette_from_color(QPalette &pal, const QColor &button) Returns the text foreground brush of the current color group. - \sa ColorRole brush() + \sa ColorRole, brush() */ /*! @@ -200,7 +200,7 @@ static void qt_palette_from_color(QPalette &pal, const QColor &button) Returns the bright text foreground brush of the current color group. - \sa ColorRole brush() + \sa ColorRole, brush() */ /*! @@ -208,7 +208,7 @@ static void qt_palette_from_color(QPalette &pal, const QColor &button) Returns the button text foreground brush of the current color group. - \sa ColorRole brush() + \sa ColorRole, brush() */ /*! @@ -216,7 +216,7 @@ static void qt_palette_from_color(QPalette &pal, const QColor &button) Returns the base brush of the current color group. - \sa ColorRole brush() + \sa ColorRole, brush() */ /*! @@ -224,7 +224,7 @@ static void qt_palette_from_color(QPalette &pal, const QColor &button) Returns the alternate base brush of the current color group. - \sa ColorRole brush() + \sa ColorRole, brush() */ /*! @@ -237,7 +237,7 @@ static void qt_palette_from_color(QPalette &pal, const QColor &button) \note Tool tips use the Inactive color group of QPalette, because tool tips are not active windows. - \sa ColorRole brush() + \sa ColorRole, brush() */ /*! @@ -250,7 +250,7 @@ static void qt_palette_from_color(QPalette &pal, const QColor &button) \note Tool tips use the Inactive color group of QPalette, because tool tips are not active windows. - \sa ColorRole brush() + \sa ColorRole, brush() */ /*! @@ -266,7 +266,7 @@ static void qt_palette_from_color(QPalette &pal, const QColor &button) Returns the window (general background) brush of the current color group. - \sa ColorRole brush() + \sa ColorRole, brush() */ /*! @@ -274,7 +274,7 @@ static void qt_palette_from_color(QPalette &pal, const QColor &button) Returns the shadow brush of the current color group. - \sa ColorRole brush() + \sa ColorRole, brush() */ /*! @@ -282,7 +282,7 @@ static void qt_palette_from_color(QPalette &pal, const QColor &button) Returns the highlight brush of the current color group. - \sa ColorRole brush() + \sa ColorRole, brush() */ /*! @@ -290,7 +290,7 @@ static void qt_palette_from_color(QPalette &pal, const QColor &button) Returns the highlighted text brush of the current color group. - \sa ColorRole brush() + \sa ColorRole, brush() */ /*! @@ -298,7 +298,7 @@ static void qt_palette_from_color(QPalette &pal, const QColor &button) Returns the unvisited link text brush of the current color group. - \sa ColorRole brush() + \sa ColorRole, brush() */ /*! @@ -306,7 +306,7 @@ static void qt_palette_from_color(QPalette &pal, const QColor &button) Returns the visited link text brush of the current color group. - \sa ColorRole brush() + \sa ColorRole, brush() */ /*! @@ -682,7 +682,7 @@ QPalette::operator QVariant() const Returns the color in the specified color \a group, used for the given color \a role. - \sa brush() setColor() ColorRole + \sa brush(), setColor(), ColorRole */ /*! @@ -691,7 +691,7 @@ QPalette::operator QVariant() const Returns the brush in the specified color \a group, used for the given color \a role. - \sa color() setBrush() ColorRole + \sa color(), setBrush(), ColorRole */ const QBrush &QPalette::brush(ColorGroup gr, ColorRole cr) const { @@ -713,7 +713,7 @@ const QBrush &QPalette::brush(ColorGroup gr, ColorRole cr) const Sets the color in the specified color \a group, used for the given color \a role, to the specified solid \a color. - \sa setBrush() color() ColorRole + \sa setBrush(), color(), ColorRole */ /*! @@ -723,7 +723,7 @@ const QBrush &QPalette::brush(ColorGroup gr, ColorRole cr) const Sets the brush in the specified color \a group, used for the given color \a role, to \a brush. - \sa brush() setColor() ColorRole + \sa brush(), setColor(), ColorRole */ void QPalette::setBrush(ColorGroup cg, ColorRole cr, const QBrush &b) { @@ -1001,7 +1001,7 @@ QDataStream &operator>>(QDataStream &s, QPalette &p) was subsequently modified; otherwise returns false. This is much stricter than equality. - \sa operator=() operator==() + \sa operator=(), operator==() */ bool QPalette::isCopyOf(const QPalette &p) const diff --git a/src/gui/kernel/qplatformintegration_qpa.cpp b/src/gui/kernel/qplatformintegration_qpa.cpp index 8e4ed05576..819f31efea 100644 --- a/src/gui/kernel/qplatformintegration_qpa.cpp +++ b/src/gui/kernel/qplatformintegration_qpa.cpp @@ -163,7 +163,7 @@ QPlatformServices *QPlatformIntegration::services() const or QWindow::setWindowState(), respectively. \sa QPlatformWindow, QPlatformWindowFormat - \sa createPlatformBackingStore(QWindow *window) const + \sa createPlatformBackingStore() */ /*! @@ -174,7 +174,7 @@ QPlatformServices *QPlatformIntegration::services() const before the QPlatformBackingStore for tlw where the widget also requires a backing store. \sa QBackingStore - \sa createPlatformWindow(QWindow *window, WId winId = 0) const + \sa createPlatformWindow() */ /*! diff --git a/src/gui/kernel/qshortcutmap.cpp b/src/gui/kernel/qshortcutmap.cpp index 267f528ca0..474fb07566 100644 --- a/src/gui/kernel/qshortcutmap.cpp +++ b/src/gui/kernel/qshortcutmap.cpp @@ -316,7 +316,7 @@ QKeySequence::SequenceMatch QShortcutMap::state() Uses ShortcutOverride event to see if any widgets want to override the event. If not, uses nextState(QKeyEvent) to check for a grabbed Shortcut, and dispatchEvent() is found an identical. - \sa nextState dispatchEvent + \sa nextState, dispatchEvent */ bool QShortcutMap::tryShortcutEvent(QObject *o, QKeyEvent *e) { |