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 | |
| 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')
27 files changed, 266 insertions, 291 deletions
diff --git a/src/gui/image/qbitmap.cpp b/src/gui/image/qbitmap.cpp index 499f9f48f2..837e5d0cd8 100644 --- a/src/gui/image/qbitmap.cpp +++ b/src/gui/image/qbitmap.cpp @@ -90,7 +90,7 @@ QT_BEGIN_NAMESPACE implicit data sharing. For more information, see the \l {Implicit Data Sharing} documentation. - \sa QPixmap, QImage, QImageReader, QImageWriter + \sa QPixmap, QImage, QImageReader, QImageWriter */ /*! \typedef QBitmap::DataPtr diff --git a/src/gui/image/qpicture.cpp b/src/gui/image/qpicture.cpp index 34ca077e5b..dde039f554 100644 --- a/src/gui/image/qpicture.cpp +++ b/src/gui/image/qpicture.cpp @@ -1189,7 +1189,7 @@ QT_END_INCLUDE_NAMESPACE fileName, or 0 if the file cannot be read or if the format is not recognized. - \sa load() save() + \sa load(), save() */ const char* QPicture::pictureFormat(const QString &fileName) @@ -1203,7 +1203,7 @@ const char* QPicture::pictureFormat(const QString &fileName) Returns a list of picture formats that are supported for picture input. - \sa outputFormats() inputFormatList() QPictureIO + \sa outputFormats(), inputFormatList(), QPictureIO */ QList<QByteArray> QPicture::inputFormats() { @@ -1228,7 +1228,7 @@ static QStringList qToStringList(const QList<QByteArray> arr) over a copy, e.g. \snippet picture/picture.cpp 2 - \sa outputFormatList() inputFormats() QPictureIO + \sa outputFormatList(), inputFormats(), QPictureIO */ QStringList QPicture::inputFormatList() { @@ -1246,7 +1246,7 @@ QStringList QPicture::inputFormatList() over a copy, e.g. \snippet picture/picture.cpp 3 - \sa inputFormatList() outputFormats() QPictureIO + \sa inputFormatList(), outputFormats(), QPictureIO */ QStringList QPicture::outputFormatList() { @@ -1259,7 +1259,7 @@ QStringList QPicture::outputFormatList() Returns a list of picture formats that are supported for picture output. - \sa inputFormats() outputFormatList() QPictureIO + \sa inputFormats(), outputFormatList(), QPictureIO */ QList<QByteArray> QPicture::outputFormats() { @@ -1288,7 +1288,7 @@ QList<QByteArray> QPicture::outputFormats() You don't normally need to use this class; QPicture::load(), QPicture::save(). - \sa QPicture QPixmap QFile + \sa QPicture, QPixmap, QFile */ struct QPictureIOData @@ -1581,7 +1581,7 @@ void QPictureIO::setStatus(int status) reading it. If a format is set the picture will only be read if it has that format. - \sa read() write() format() + \sa read(), write(), format() */ void QPictureIO::setFormat(const char *format) { @@ -1619,7 +1619,7 @@ void QPictureIO::setFileName(const QString &fileName) Returns the quality of the written picture, related to the compression ratio. - \sa setQuality() QPicture::save() + \sa setQuality(), QPicture::save() */ int QPictureIO::quality() const { @@ -1634,7 +1634,7 @@ int QPictureIO::quality() const compressed files, 100 for large uncompressed files. (-1 signifies the default compression.) - \sa quality() QPicture::save() + \sa quality(), QPicture::save() */ void QPictureIO::setQuality(int q) @@ -1841,7 +1841,7 @@ QList<QByteArray> QPictureIO::outputFormats() \snippet picture/picture.cpp 4 - \sa setIODevice() setFileName() setFormat() write() QPixmap::load() + \sa setIODevice(), setFileName(), setFormat(), write(), QPixmap::load() */ bool QPictureIO::read() { @@ -1910,7 +1910,7 @@ bool QPictureIO::read() Example: \snippet picture/picture.cpp 5 - \sa setIODevice() setFileName() setFormat() read() QPixmap::save() + \sa setIODevice(), setFileName(), setFormat(), read(), QPixmap::save() */ bool QPictureIO::write() { 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) { diff --git a/src/gui/painting/qcolor.cpp b/src/gui/painting/qcolor.cpp index 81f5a7438a..c45136e1d8 100644 --- a/src/gui/painting/qcolor.cpp +++ b/src/gui/painting/qcolor.cpp @@ -589,7 +589,7 @@ QStringList QColor::colorNames() These components can be retrieved individually using the hueF(), saturationF(), valueF() and alphaF() functions. - \sa setHsv() {QColor#The HSV Color Model}{The HSV Color Model} + \sa setHsv(), {QColor#The HSV Color Model}{The HSV Color Model} */ void QColor::getHsvF(qreal *h, qreal *s, qreal *v, qreal *a) const { @@ -643,8 +643,7 @@ void QColor::getHsv(int *h, int *s, int *v, int *a) const All the values must be in the range 0.0-1.0. - \sa getHsvF(), setHsv(), {QColor#The HSV Color Model}{The HSV - Color Model} + \sa getHsvF(), setHsv(), {QColor#The HSV Color Model}{The HSV Color Model} */ void QColor::setHsvF(qreal h, qreal s, qreal v, qreal a) { @@ -671,8 +670,7 @@ void QColor::setHsvF(qreal h, qreal s, qreal v, qreal a) The saturation, value and alpha-channel values must be in the range 0-255, and the hue value must be greater than -1. - \sa getHsv(), setHsvF(), {QColor#The HSV Color Model}{The HSV - Color Model} + \sa getHsv(), setHsvF(), {QColor#The HSV Color Model}{The HSV Color Model} */ void QColor::setHsv(int h, int s, int v, int a) { @@ -978,8 +976,7 @@ void QColor::setRgb(QRgb rgb) /*! Returns the alpha color component of this color. - \sa setAlpha(), alphaF(), {QColor#Alpha-Blended - Drawing}{Alpha-Blended Drawing} + \sa setAlpha(), alphaF(), {QColor#Alpha-Blended Drawing}{Alpha-Blended Drawing} */ int QColor::alpha() const { return ct.argb.alpha >> 8; } @@ -989,8 +986,7 @@ int QColor::alpha() const Sets the alpha of this color to \a alpha. Integer alpha is specified in the range 0-255. - \sa alpha(), alphaF(), {QColor#Alpha-Blended - Drawing}{Alpha-Blended Drawing} + \sa alpha(), alphaF(), {QColor#Alpha-Blended Drawing}{Alpha-Blended Drawing} */ void QColor::setAlpha(int alpha) @@ -1002,8 +998,7 @@ void QColor::setAlpha(int alpha) /*! Returns the alpha color component of this color. - \sa setAlphaF(), alpha(), {QColor#Alpha-Blended - Drawing}{Alpha-Blended Drawing} + \sa setAlphaF(), alpha(), {QColor#Alpha-Blended Drawing}{Alpha-Blended Drawing} */ qreal QColor::alphaF() const { return ct.argb.alpha / qreal(USHRT_MAX); } @@ -1012,8 +1007,7 @@ qreal QColor::alphaF() const Sets the alpha of this color to \a alpha. qreal alpha is specified in the range 0.0-1.0. - \sa alphaF(), alpha(), {QColor#Alpha-Blended - Drawing}{Alpha-Blended Drawing} + \sa alphaF(), alpha(), {QColor#Alpha-Blended Drawing}{Alpha-Blended Drawing} */ void QColor::setAlphaF(qreal alpha) @@ -1067,7 +1061,7 @@ int QColor::green() const Sets the green color component of this color to \a green. Integer components are specified in the range 0-255. - \sa green(), greenF(), setRgb() + \sa green(), greenF(), setRgb() */ void QColor::setGreen(int green) { @@ -1195,8 +1189,7 @@ void QColor::setBlueF(qreal blue) The color is implicitly converted to HSV. - \sa hsvHue(), hueF(), getHsv(), {QColor#The HSV Color Model}{The HSV Color - Model} + \sa hsvHue(), hueF(), getHsv(), {QColor#The HSV Color Model}{The HSV Color Model} */ int QColor::hue() const @@ -1207,8 +1200,7 @@ int QColor::hue() const /*! Returns the hue color component of this color. - \sa hueF(), getHsv(), {QColor#The HSV Color Model}{The HSV Color - Model} + \sa hueF(), getHsv(), {QColor#The HSV Color Model}{The HSV Color Model} */ int QColor::hsvHue() const { @@ -1234,8 +1226,7 @@ int QColor::saturation() const /*! Returns the saturation color component of this color. - \sa saturationF(), getHsv(), {QColor#The HSV Color Model}{The HSV Color - Model} + \sa saturationF(), getHsv(), {QColor#The HSV Color Model}{The HSV Color Model} */ int QColor::hsvSaturation() const { @@ -1247,8 +1238,7 @@ int QColor::hsvSaturation() const /*! Returns the value color component of this color. - \sa valueF(), getHsv(), {QColor#The HSV Color Model}{The HSV Color - Model} + \sa valueF(), getHsv(), {QColor#The HSV Color Model}{The HSV Color Model} */ int QColor::value() const { @@ -1262,8 +1252,7 @@ int QColor::value() const The color is implicitly converted to HSV. - \sa hsvHueF(), hue(), getHsvF(), {QColor#The HSV Color Model}{The HSV Color - Model} + \sa hsvHueF(), hue(), getHsvF(), {QColor#The HSV Color Model}{The HSV Color Model} */ qreal QColor::hueF() const { @@ -1288,7 +1277,7 @@ qreal QColor::hsvHueF() const The color is implicitly converted to HSV. - \sa hsvSaturationF(), saturation() getHsvF(), {QColor#The HSV Color Model}{The HSV Color + \sa hsvSaturationF(), saturation(), getHsvF(), {QColor#The HSV Color Model}{The HSV Color Model} */ qreal QColor::saturationF() const @@ -1299,8 +1288,7 @@ qreal QColor::saturationF() const /*! Returns the saturation color component of this color. - \sa saturation() getHsvF(), {QColor#The HSV Color Model}{The HSV Color - Model} + \sa saturation(), getHsvF(), {QColor#The HSV Color Model}{The HSV Color Model} */ qreal QColor::hsvSaturationF() const { @@ -1312,8 +1300,7 @@ qreal QColor::hsvSaturationF() const /*! Returns the value color component of this color. - \sa value() getHsvF(), {QColor#The HSV Color Model}{The HSV Color - Model} + \sa value(), getHsvF(), {QColor#The HSV Color Model}{The HSV Color Model} */ qreal QColor::valueF() const { @@ -1341,8 +1328,7 @@ int QColor::hslHue() const Returns the saturation color component of this color. - \sa saturationF(), getHsv(), {QColor#The HSV Color Model}{The HSV Color - Model} + \sa saturationF(), getHsv(), {QColor#The HSV Color Model}{The HSV Color Model} */ int QColor::hslSaturation() const { @@ -1384,7 +1370,7 @@ qreal QColor::hslHueF() const Returns the saturation color component of this color. - \sa saturationF() getHslF() + \sa saturationF(), getHslF() */ qreal QColor::hslSaturationF() const { @@ -1398,7 +1384,7 @@ qreal QColor::hslSaturationF() const Returns the lightness color component of this color. - \sa value() getHslF() + \sa value(), getHslF() */ qreal QColor::lightnessF() const { @@ -1410,8 +1396,7 @@ qreal QColor::lightnessF() const /*! Returns the cyan color component of this color. - \sa cyanF(), getCmyk(), {QColor#The CMYK Color Model}{The CMYK - Color Model} + \sa cyanF(), getCmyk(), {QColor#The CMYK Color Model}{The CMYK Color Model} */ int QColor::cyan() const { @@ -1423,8 +1408,7 @@ int QColor::cyan() const /*! Returns the magenta color component of this color. - \sa magentaF(), getCmyk(), {QColor#The CMYK Color Model}{The CMYK - Color Model} + \sa magentaF(), getCmyk(), {QColor#The CMYK Color Model}{The CMYK Color Model} */ int QColor::magenta() const { @@ -1436,8 +1420,7 @@ int QColor::magenta() const /*! Returns the yellow color component of this color. - \sa yellowF(), getCmyk(), {QColor#The CMYK Color Model}{The CMYK - Color Model} + \sa yellowF(), getCmyk(), {QColor#The CMYK Color Model}{The CMYK Color Model} */ int QColor::yellow() const { @@ -1449,8 +1432,7 @@ int QColor::yellow() const /*! Returns the black color component of this color. - \sa blackF(), getCmyk(), {QColor#The CMYK Color Model}{The CMYK - Color Model} + \sa blackF(), getCmyk(), {QColor#The CMYK Color Model}{The CMYK Color Model} */ int QColor::black() const @@ -1463,8 +1445,7 @@ int QColor::black() const /*! Returns the cyan color component of this color. - \sa cyan(), getCmykF(), {QColor#The CMYK Color Model}{The CMYK - Color Model} + \sa cyan(), getCmykF(), {QColor#The CMYK Color Model}{The CMYK Color Model} */ qreal QColor::cyanF() const { @@ -1476,8 +1457,7 @@ qreal QColor::cyanF() const /*! Returns the magenta color component of this color. - \sa magenta(), getCmykF(), {QColor#The CMYK Color Model}{The CMYK - Color Model} + \sa magenta(), getCmykF(), {QColor#The CMYK Color Model}{The CMYK Color Model} */ qreal QColor::magentaF() const { @@ -1489,8 +1469,7 @@ qreal QColor::magentaF() const /*! Returns the yellow color component of this color. - \sa yellow(), getCmykF(), {QColor#The CMYK Color Model}{The CMYK - Color Model} + \sa yellow(), getCmykF(), {QColor#The CMYK Color Model}{The CMYK Color Model} */ qreal QColor::yellowF() const { @@ -1502,8 +1481,7 @@ qreal QColor::yellowF() const /*! Returns the black color component of this color. - \sa black(), getCmykF(), {QColor#The CMYK Color Model}{The CMYK - Color Model} + \sa black(), getCmykF(), {QColor#The CMYK Color Model}{The CMYK Color Model} */ qreal QColor::blackF() const { @@ -1661,8 +1639,7 @@ QColor QColor::toRgb() const /*! Creates and returns an HSV QColor based on this color. - \sa fromHsv(), convertTo(), isValid(), {QColor#The HSV Color - Model}{The HSV Color Model} + \sa fromHsv(), convertTo(), isValid(), {QColor#The HSV Color Model}{The HSV Color Model} */ QColor QColor::toHsv() const { @@ -1769,8 +1746,7 @@ QColor QColor::toHsl() const /*! Creates and returns a CMYK QColor based on this color. - \sa fromCmyk(), convertTo(), isValid(), {QColor#The CMYK Color - Model}{The CMYK Color Model} + \sa fromCmyk(), convertTo(), isValid(), {QColor#The CMYK Color Model}{The CMYK Color Model} */ QColor QColor::toCmyk() const { @@ -1926,8 +1902,7 @@ QColor QColor::fromRgbF(qreal r, qreal g, qreal b, qreal a) The value of \a s, \a v, and \a a must all be in the range 0-255; the value of \a h must be in the range 0-359. - \sa toHsv(), fromHsvF(), isValid(), {QColor#The HSV Color - Model}{The HSV Color Model} + \sa toHsv(), fromHsvF(), isValid(), {QColor#The HSV Color Model}{The HSV Color Model} */ QColor QColor::fromHsv(int h, int s, int v, int a) { @@ -1958,8 +1933,7 @@ QColor QColor::fromHsv(int h, int s, int v, int a) All the values must be in the range 0.0-1.0. - \sa toHsv(), fromHsv(), isValid(), {QColor#The HSV Color - Model}{The HSV Color Model} + \sa toHsv(), fromHsv(), isValid(), {QColor#The HSV Color Model}{The HSV Color Model} */ QColor QColor::fromHsvF(qreal h, qreal s, qreal v, qreal a) { @@ -2112,8 +2086,7 @@ void QColor::getCmykF(qreal *c, qreal *m, qreal *y, qreal *k, qreal *a) All the values must be in the range 0-255. - \sa getCmyk(), setCmykF(), {QColor#The CMYK Color Model}{The - CMYK Color Model} + \sa getCmyk(), setCmykF(), {QColor#The CMYK Color Model}{The CMYK Color Model} */ void QColor::setCmyk(int c, int m, int y, int k, int a) { @@ -2142,8 +2115,7 @@ void QColor::setCmyk(int c, int m, int y, int k, int a) All the values must be in the range 0.0-1.0. - \sa getCmykF() setCmyk(), {QColor#The CMYK Color Model}{The CMYK - Color Model} + \sa getCmykF(), setCmyk(), {QColor#The CMYK Color Model}{The CMYK Color Model} */ void QColor::setCmykF(qreal c, qreal m, qreal y, qreal k, qreal a) { @@ -2171,8 +2143,7 @@ void QColor::setCmykF(qreal c, qreal m, qreal y, qreal k, qreal a) All the values must be in the range 0-255. - \sa toCmyk(), fromCmykF(), isValid(), {QColor#The CMYK Color Model}{The CMYK - Color Model} + \sa toCmyk(), fromCmykF(), isValid(), {QColor#The CMYK Color Model}{The CMYK Color Model} */ QColor QColor::fromCmyk(int c, int m, int y, int k, int a) { @@ -2204,8 +2175,7 @@ QColor QColor::fromCmyk(int c, int m, int y, int k, int a) All the values must be in the range 0.0-1.0. - \sa toCmyk(), fromCmyk(), isValid(), {QColor#The CMYK Color - Model}{The CMYK Color Model} + \sa toCmyk(), fromCmyk(), isValid(), {QColor#The CMYK Color Model}{The CMYK Color Model} */ QColor QColor::fromCmykF(qreal c, qreal m, qreal y, qreal k, qreal a) { diff --git a/src/gui/painting/qmatrix.cpp b/src/gui/painting/qmatrix.cpp index afefb1787c..5b2ccbd056 100644 --- a/src/gui/painting/qmatrix.cpp +++ b/src/gui/painting/qmatrix.cpp @@ -177,8 +177,8 @@ QT_BEGIN_NAMESPACE \snippet matrix/matrix.cpp 2 \endtable - \sa QPainter, QTransform, {Coordinate System}, - {painting/affine}{Affine Transformations Example}, {Transformations Example} + \sa QPainter, QTransform, {Coordinate System}, + {painting/affine}{Affine Transformations Example}, {Transformations Example} */ @@ -1157,7 +1157,7 @@ QDebug operator<<(QDebug dbg, const QMatrix &m) \brief The qFuzzyCompare function is for comparing two matrices using a fuzziness factor. - + Returns true if \a m1 and \a m2 are equal, allowing for a small fuzziness factor for floating-point comparisons; false otherwise. */ diff --git a/src/gui/painting/qpaintdevice.qdoc b/src/gui/painting/qpaintdevice.qdoc index 47c518ce10..eb7bdcdd1c 100644 --- a/src/gui/painting/qpaintdevice.qdoc +++ b/src/gui/painting/qpaintdevice.qdoc @@ -242,7 +242,7 @@ Note that if the logicalDpiY() doesn't equal the physicalDpiY(), the corresponding QPaintEngine must handle the resolution mapping. - \sa logicalDpiX(), physicalDpiY() + \sa logicalDpiX(), physicalDpiY() */ /*! @@ -256,7 +256,7 @@ Note that if the physicalDpiX() doesn't equal the logicalDpiX(), the corresponding QPaintEngine must handle the resolution mapping. - \sa physicalDpiY(), logicalDpiX() + \sa physicalDpiY(), logicalDpiX() */ /*! @@ -270,5 +270,5 @@ Note that if the physicalDpiY() doesn't equal the logicalDpiY(), the corresponding QPaintEngine must handle the resolution mapping. - \sa physicalDpiX(), logicalDpiY() + \sa physicalDpiX(), logicalDpiY() */ diff --git a/src/gui/painting/qpaintengine.cpp b/src/gui/painting/qpaintengine.cpp index eb6d186f78..4af2651ce8 100644 --- a/src/gui/painting/qpaintengine.cpp +++ b/src/gui/painting/qpaintengine.cpp @@ -414,7 +414,7 @@ void QPaintEngine::drawPolygon(const QPoint *points, int pointCount, PolygonDraw painting is to start on the paint device \a pdev. Return true if the initialization was successful; otherwise return false. - \sa end() isActive() + \sa end(), isActive() */ /*! @@ -424,7 +424,7 @@ void QPaintEngine::drawPolygon(const QPoint *points, int pointCount, PolygonDraw device. Return true if painting was finished successfully; otherwise return false. - \sa begin() isActive() + \sa begin(), isActive() */ diff --git a/src/gui/painting/qpainter.cpp b/src/gui/painting/qpainter.cpp index e622fe46a7..d6becf0562 100644 --- a/src/gui/painting/qpainter.cpp +++ b/src/gui/painting/qpainter.cpp @@ -3085,8 +3085,7 @@ bool QPainter::matrixEnabled() const /*! Scales the coordinate system by (\a{sx}, \a{sy}). - \sa setWorldTransform() {QPainter#Coordinate Transformations}{Coordinate - Transformations} + \sa setWorldTransform(), {QPainter#Coordinate Transformations}{Coordinate Transformations} */ void QPainter::scale(qreal sx, qreal sy) @@ -3109,8 +3108,7 @@ void QPainter::scale(qreal sx, qreal sy) /*! Shears the coordinate system by (\a{sh}, \a{sv}). - \sa setWorldTransform(), {QPainter#Coordinate Transformations}{Coordinate - Transformations} + \sa setWorldTransform(), {QPainter#Coordinate Transformations}{Coordinate Transformations} */ void QPainter::shear(qreal sh, qreal sv) @@ -3135,8 +3133,7 @@ void QPainter::shear(qreal sh, qreal sv) Rotates the coordinate system the given \a angle clockwise. - \sa setWorldTransform(), {QPainter#Coordinate Transformations}{Coordinate - Transformations} + \sa setWorldTransform(), {QPainter#Coordinate Transformations}{Coordinate Transformations} */ void QPainter::rotate(qreal a) @@ -3160,8 +3157,7 @@ void QPainter::rotate(qreal a) Translates the coordinate system by the given \a offset; i.e. the given \a offset is added to points. - \sa setWorldTransform(), {QPainter#Coordinate Transformations}{Coordinate - Transformations} + \sa setWorldTransform(), {QPainter#Coordinate Transformations}{Coordinate Transformations} */ void QPainter::translate(const QPointF &offset) { @@ -4794,7 +4790,7 @@ void QPainter::drawPolyline(const QPoint *points, int pointCount) \l{Qt::FillRule} for a more detailed description of these fill rules. - \sa drawConvexPolygon(), drawPolyline(), {Coordinate System} + \sa drawConvexPolygon(), drawPolyline(), {Coordinate System} */ void QPainter::drawPolygon(const QPointF *points, int pointCount, Qt::FillRule fillRule) { @@ -7140,7 +7136,7 @@ QRect QPainter::window() const The default viewport rectangle is the same as the device's rectangle. - \sa viewport(), viewTransformEnabled() {Coordinate + \sa viewport(), viewTransformEnabled(), {Coordinate System#Window-Viewport Conversion}{Window-Viewport Conversion} */ @@ -8102,7 +8098,7 @@ qreal QPaintEngineState::opacity() const If \a combine is true, the specified \a transform is combined with the current matrix; otherwise it replaces the current matrix. - \sa transform() setWorldTransform() + \sa transform(), setWorldTransform() */ void QPainter::setTransform(const QTransform &transform, bool combine ) diff --git a/src/gui/painting/qpainterpath.cpp b/src/gui/painting/qpainterpath.cpp index dc310520e0..f249fe1f4a 100644 --- a/src/gui/painting/qpainterpath.cpp +++ b/src/gui/painting/qpainterpath.cpp @@ -344,7 +344,7 @@ static void qt_debug_path(const QPainterPath &path) \value CurveToDataElement The extra data required to describe a curve in a CurveToElement element. - \sa elementAt(), elementCount() + \sa elementAt(), elementCount() */ /*! diff --git a/src/gui/painting/qpen.cpp b/src/gui/painting/qpen.cpp index 2c95a9f146..9d03f7591c 100644 --- a/src/gui/painting/qpen.cpp +++ b/src/gui/painting/qpen.cpp @@ -309,7 +309,7 @@ QPen::QPen(const QColor &color) Constructs a pen with the specified \a brush, \a width, pen \a style, \a cap style and \a join style. - \sa setBrush(), setWidth(), setStyle(), setCapStyle(), setJoinStyle() + \sa setBrush(), setWidth(), setStyle(), setCapStyle(), setJoinStyle() */ QPen::QPen(const QBrush &brush, qreal width, Qt::PenStyle s, Qt::PenCapStyle c, Qt::PenJoinStyle j) @@ -556,7 +556,7 @@ void QPen::setDashOffset(qreal offset) Returns the miter limit of the pen. The miter limit is only relevant when the join style is set to Qt::MiterJoin. - \sa setMiterLimit(), {QPen#Join Style}{Join Style} + \sa setMiterLimit(), {QPen#Join Style}{Join Style} */ qreal QPen::miterLimit() const { @@ -606,7 +606,7 @@ int QPen::width() const Returns the pen width with floating point precision. - \sa setWidthF() width() + \sa setWidthF(), width() */ qreal QPen::widthF() const { @@ -649,7 +649,7 @@ void QPen::setWidth(int width) Setting a pen width with a negative value is not supported. - \sa setWidth() widthF() + \sa setWidth(), widthF() */ void QPen::setWidthF(qreal width) @@ -693,7 +693,7 @@ void QPen::setCapStyle(Qt::PenCapStyle c) /*! Returns the pen's join style. - \sa setJoinStyle(), {QPen#Join Style}{Join Style} + \sa setJoinStyle(), {QPen#Join Style}{Join Style} */ Qt::PenJoinStyle QPen::joinStyle() const { diff --git a/src/gui/painting/qpolygon.cpp b/src/gui/painting/qpolygon.cpp index b7dee7ff2a..38f70d9e2a 100644 --- a/src/gui/painting/qpolygon.cpp +++ b/src/gui/painting/qpolygon.cpp @@ -306,7 +306,7 @@ void QPolygon::point(int index, int *x, int *y) const \snippet polygon/polygon.cpp 2 - \sa setPoint() putPoints() + \sa setPoint(), putPoints() */ void QPolygon::setPoints(int nPoints, const int *points) diff --git a/src/gui/text/qfont.cpp b/src/gui/text/qfont.cpp index f64b3e823d..753fe5670f 100644 --- a/src/gui/text/qfont.cpp +++ b/src/gui/text/qfont.cpp @@ -607,7 +607,7 @@ QFontEngineData::~QFontEngineData() Returns the family name that corresponds to the current style hint. - \sa StyleHint styleHint() setStyleHint() + \sa StyleHint, styleHint(), setStyleHint() */ /*! @@ -629,7 +629,7 @@ QFontEngineData::~QFontEngineData() happens. Please \link bughowto.html report it as a bug\endlink if it does, preferably with a list of the fonts you have installed. - \sa lastResortFamily() rawName() + \sa lastResortFamily(), rawName() */ /*! @@ -702,7 +702,7 @@ QFont::QFont() algorithm. \sa Weight, setFamily(), setPointSize(), setWeight(), setItalic(), - setStyleHint() QGuiApplication::font() + setStyleHint(), QGuiApplication::font() */ QFont::QFont(const QString &family, int pointSize, int weight, bool italic) : d(new QFontPrivate()), resolve_mask(QFont::FamilyResolved) @@ -758,7 +758,7 @@ QFont &QFont::operator=(const QFont &font) Returns the requested font family name, i.e. the name set in the constructor or the last setFont() call. - \sa setFamily() substitutes() substitute() + \sa setFamily(), substitutes(), substitute() */ QString QFont::family() const { @@ -796,7 +796,7 @@ void QFont::setFamily(const QString &family) Mac OS X and X11 so far. On Windows irregular styles will be added as separate font families so there is no need for this. - \sa setFamily() setStyle() + \sa setFamily(), setStyle() */ QString QFont::styleName() const { @@ -823,7 +823,7 @@ void QFont::setStyleName(const QString &styleName) Returns the point size of the font. Returns -1 if the font size was specified in pixels. - \sa setPointSize() pointSizeF() + \sa setPointSize(), pointSizeF() */ int QFont::pointSize() const { @@ -933,7 +933,7 @@ QFont::HintingPreference QFont::hintingPreference() const Sets the point size to \a pointSize. The point size must be greater than zero. - \sa pointSize() setPointSizeF() + \sa pointSize(), setPointSizeF() */ void QFont::setPointSize(int pointSize) { @@ -955,7 +955,7 @@ void QFont::setPointSize(int pointSize) greater than zero. The requested precision may not be achieved on all platforms. - \sa pointSizeF() setPointSize() setPixelSize() + \sa pointSizeF(), setPointSize(), setPixelSize() */ void QFont::setPointSizeF(qreal pointSize) { @@ -976,7 +976,7 @@ void QFont::setPointSizeF(qreal pointSize) Returns the point size of the font. Returns -1 if the font size was specified in pixels. - \sa pointSize() setPointSizeF() pixelSize() QFontInfo::pointSize() QFontInfo::pixelSize() + \sa pointSize(), setPointSizeF(), pixelSize(), QFontInfo::pointSize(), QFontInfo::pixelSize() */ qreal QFont::pointSizeF() const { @@ -1012,7 +1012,7 @@ void QFont::setPixelSize(int pixelSize) setPixelSize(). Returns -1 if the size was set with setPointSize() or setPointSizeF(). - \sa setPixelSize() pointSize() QFontInfo::pointSize() QFontInfo::pixelSize() + \sa setPixelSize(), pointSize(), QFontInfo::pointSize(), QFontInfo::pixelSize() */ int QFont::pixelSize() const { @@ -1024,7 +1024,7 @@ int QFont::pixelSize() const Returns true if the style() of the font is not QFont::StyleNormal - \sa setItalic() style() + \sa setItalic(), style() */ /*! @@ -1033,7 +1033,7 @@ int QFont::pixelSize() const Sets the style() of the font to QFont::StyleItalic if \a enable is true; otherwise the style is set to QFont::StyleNormal. - \sa italic() QFontInfo + \sa italic(), QFontInfo */ /*! @@ -1254,7 +1254,7 @@ void QFont::setKerning(bool enable) The style strategy affects the \l{QFont}{font matching} algorithm. See \l QFont::StyleStrategy for the list of available strategies. - \sa setStyleHint() QFont::StyleHint + \sa setStyleHint(), QFont::StyleHint */ QFont::StyleStrategy QFont::styleStrategy() const { @@ -1267,7 +1267,7 @@ QFont::StyleStrategy QFont::styleStrategy() const The style hint affects the \l{QFont}{font matching} algorithm. See \l QFont::StyleHint for the list of available hints. - \sa setStyleHint(), QFont::StyleStrategy QFontInfo::styleHint() + \sa setStyleHint(), QFont::StyleStrategy, QFontInfo::styleHint() */ QFont::StyleHint QFont::styleHint() const { @@ -1407,7 +1407,7 @@ void QFont::setStyleStrategy(StyleStrategy s) \value ExtraExpanded 150 \value UltraExpanded 200 - \sa setStretch() stretch() + \sa setStretch(), stretch() */ /*! @@ -1436,7 +1436,7 @@ int QFont::stretch() const X11, the stretch factor is matched against a predefined set of values for the SETWIDTH_NAME field of the XLFD. - \sa stretch() QFont::Stretch + \sa stretch(), QFont::Stretch */ void QFont::setStretch(int factor) { @@ -1647,7 +1647,7 @@ bool QFont::exactMatch() const equal. If rawMode() is enabled for both fonts, only the family fields are compared. - \sa operator!=() isCopyOf() + \sa operator!=(), isCopyOf() */ bool QFont::operator==(const QFont &f) const { @@ -1675,7 +1675,7 @@ bool QFont::operator==(const QFont &f) const This function is useful in some circumstances, for example if you want to use QFont objects as keys in a QMap. - \sa operator==() operator!=() isCopyOf() + \sa operator==(), operator!=(), isCopyOf() */ bool QFont::operator<(const QFont &f) const { @@ -1731,7 +1731,7 @@ QFont::operator QVariant() const one of them was created as a copy of the other and neither has been modified since. This is much stricter than equality. - \sa operator=() operator==() + \sa operator=(), operator==() */ bool QFont::isCopyOf(const QFont & f) const { @@ -1742,7 +1742,7 @@ bool QFont::isCopyOf(const QFont & f) const Returns true if raw mode is used for font name matching; otherwise returns false. - \sa setRawMode() rawName() + \sa setRawMode(), rawName() */ bool QFont::rawMode() const { @@ -1797,7 +1797,7 @@ Q_GLOBAL_STATIC(QFontSubst, globalFontSubst) To obtain a list of substitutions use substitutes(). - \sa setFamily() insertSubstitutions() insertSubstitution() removeSubstitutions() + \sa setFamily(), insertSubstitutions(), insertSubstitution(), removeSubstitutions() */ QString QFont::substitute(const QString &familyName) { @@ -1818,7 +1818,7 @@ QString QFont::substitute(const QString &familyName) If there is no substitution for \a familyName, an empty list is returned. - \sa substitute() insertSubstitutions() insertSubstitution() removeSubstitutions() + \sa substitute(), insertSubstitutions(), insertSubstitution(), removeSubstitutions() */ QStringList QFont::substitutes(const QString &familyName) { @@ -1832,7 +1832,7 @@ QStringList QFont::substitutes(const QString &familyName) Inserts \a substituteName into the substitution table for the family \a familyName. - \sa insertSubstitutions() removeSubstitutions() substitutions() substitute() substitutes() + \sa insertSubstitutions(), removeSubstitutions(), substitutions(), substitute(), substitutes() */ void QFont::insertSubstitution(const QString &familyName, const QString &substituteName) @@ -2266,7 +2266,7 @@ QDataStream &operator>>(QDataStream &s, QFont &font) info object is \e not updated. \endlist - \sa QFont QFontMetrics QFontDatabase + \sa QFont, QFontMetrics, QFontDatabase */ /*! @@ -2343,7 +2343,7 @@ QString QFontInfo::styleName() const /*! Returns the point size of the matched window system font. - \sa pointSizeF() QFont::pointSize() + \sa pointSizeF(), QFont::pointSize() */ int QFontInfo::pointSize() const { @@ -2492,7 +2492,7 @@ bool QFontInfo::fixedPitch() const Currently only returns the style hint set in QFont. - \sa QFont::styleHint() QFont::StyleHint + \sa QFont::styleHint(), QFont::StyleHint */ QFont::StyleHint QFontInfo::styleHint() const { diff --git a/src/gui/text/qfontmetrics.cpp b/src/gui/text/qfontmetrics.cpp index cc6fa4bfee..141ef64e53 100644 --- a/src/gui/text/qfontmetrics.cpp +++ b/src/gui/text/qfontmetrics.cpp @@ -978,7 +978,7 @@ int QFontMetrics::lineWidth() const Example: \snippet code/src_gui_text_qfontmetrics.cpp 1 - \sa QFont QFontInfo QFontDatabase + \sa QFont, QFontInfo, QFontDatabase */ /*! diff --git a/src/gui/text/qtextcursor.cpp b/src/gui/text/qtextcursor.cpp index ce46ec2e59..048f1a5ca0 100644 --- a/src/gui/text/qtextcursor.cpp +++ b/src/gui/text/qtextcursor.cpp @@ -1138,7 +1138,7 @@ bool QTextCursor::isNull() const \a pos using a \c MoveMode specified by \a m. The cursor is positioned between characters. - \sa position() movePosition() anchor() + \sa position(), movePosition(), anchor() */ void QTextCursor::setPosition(int pos, MoveMode m) { @@ -1169,7 +1169,7 @@ void QTextCursor::setPosition(int pos, MoveMode m) Returns the absolute position of the cursor within the document. The cursor is positioned between characters. - \sa setPosition() movePosition() anchor() positionInBlock() + \sa setPosition(), movePosition(), anchor(), positionInBlock() */ int QTextCursor::position() const { @@ -1200,7 +1200,7 @@ int QTextCursor::positionInBlock() const selection and anchor() marks the other end. Just like the cursor position, the anchor position is between characters. - \sa position() setPosition() movePosition() selectionStart() selectionEnd() + \sa position(), setPosition(), movePosition(), selectionStart(), selectionEnd() */ int QTextCursor::anchor() const { @@ -1388,7 +1388,7 @@ void QTextCursor::setKeepPositionOnInsert(bool b) Any ASCII linefeed characters (\\n) in the inserted text are transformed into unicode block separators, corresponding to insertBlock() calls. - \sa charFormat() hasSelection() + \sa charFormat(), hasSelection() */ void QTextCursor::insertText(const QString &text) { @@ -1476,7 +1476,7 @@ void QTextCursor::insertText(const QString &text, const QTextCharFormat &_format If there is no selected text, deletes the character \e at the current cursor position; otherwise deletes the selected text. - \sa deletePreviousChar() hasSelection() clearSelection() + \sa deletePreviousChar(), hasSelection(), clearSelection() */ void QTextCursor::deleteChar() { @@ -1500,7 +1500,7 @@ void QTextCursor::deleteChar() If there is no selected text, deletes the character \e before the current cursor position; otherwise deletes the selected text. - \sa deleteChar() hasSelection() clearSelection() + \sa deleteChar(), hasSelection(), clearSelection() */ void QTextCursor::deletePreviousChar() { @@ -1623,7 +1623,7 @@ void QTextCursor::selectedTableCells(int *firstRow, int *numRows, int *firstColu Note that it does \b{not} delete the text of the selection. - \sa removeSelectedText() hasSelection() + \sa removeSelectedText(), hasSelection() */ void QTextCursor::clearSelection() { @@ -1654,7 +1654,7 @@ void QTextCursor::removeSelectedText() Returns the start of the selection or position() if the cursor doesn't have a selection. - \sa selectionEnd() position() anchor() + \sa selectionEnd(), position(), anchor() */ int QTextCursor::selectionStart() const { @@ -1667,7 +1667,7 @@ int QTextCursor::selectionStart() const Returns the end of the selection or position() if the cursor doesn't have a selection. - \sa selectionStart() position() anchor() + \sa selectionStart(), position(), anchor() */ int QTextCursor::selectionEnd() const { @@ -1770,7 +1770,7 @@ QTextBlock QTextCursor::block() const /*! Returns the block format of the block the cursor is in. - \sa setBlockFormat() charFormat() + \sa setBlockFormat(), charFormat() */ QTextBlockFormat QTextCursor::blockFormat() const { @@ -2049,7 +2049,7 @@ void QTextCursor::insertBlock(const QTextBlockFormat &format, const QTextCharFor list item of a newly created list with the given \a format. Returns the created list. - \sa currentList() createList() insertBlock() + \sa currentList(), createList(), insertBlock() */ QTextList *QTextCursor::insertList(const QTextListFormat &format) { @@ -2076,7 +2076,7 @@ QTextList *QTextCursor::insertList(QTextListFormat::Style style) Creates and returns a new list with the given \a format, and makes the current paragraph the cursor is in the first list item. - \sa insertList() currentList() + \sa insertList(), currentList() */ QTextList *QTextCursor::createList(const QTextListFormat &format) { @@ -2098,7 +2098,7 @@ QTextList *QTextCursor::createList(const QTextListFormat &format) The style to be used is defined by the QTextListFormat::Style enum. - \sa insertList() currentList() + \sa insertList(), currentList() */ QTextList *QTextCursor::createList(QTextListFormat::Style style) { @@ -2111,7 +2111,7 @@ QTextList *QTextCursor::createList(QTextListFormat::Style style) Returns the current list if the cursor position() is inside a block that is part of a list; otherwise returns 0. - \sa insertList() createList() + \sa insertList(), createList() */ QTextList *QTextCursor::currentList() const { @@ -2509,7 +2509,7 @@ void QTextCursor::endEditBlock() one of them was created as a copy of the other and neither has moved since. This is much stricter than equality. - \sa operator=() operator==() + \sa operator=(), operator==() */ bool QTextCursor::isCopyOf(const QTextCursor &other) const { diff --git a/src/gui/text/qtextdocument.cpp b/src/gui/text/qtextdocument.cpp index f0546566d4..d0a15859ee 100644 --- a/src/gui/text/qtextdocument.cpp +++ b/src/gui/text/qtextdocument.cpp @@ -272,7 +272,7 @@ QTextCodec *Qt::codecForHtml(const QByteArray &ba) \li Text block group format changes. \endlist - \sa QTextCursor, QTextEdit, \link richtext.html Rich Text Processing\endlink , {Text Object Example} + \sa QTextCursor, QTextEdit, {Rich Text Processing}, {Text Object Example} */ /*! @@ -432,7 +432,7 @@ void QTextDocument::redo(QTextCursor *cursor) signals are emitted, QTextDocument::undoAvailable() or QTextDocument::redoAvailable(). - \sa QTextDocument::undoAvailable() QTextDocument::redoAvailable() + \sa QTextDocument::undoAvailable(), QTextDocument::redoAvailable() */ void QTextDocument::clearUndoRedoStacks(Stacks stacksToClear) { diff --git a/src/gui/text/qtextdocumentfragment.cpp b/src/gui/text/qtextdocumentfragment.cpp index 72113bc977..d1147339f6 100644 --- a/src/gui/text/qtextdocumentfragment.cpp +++ b/src/gui/text/qtextdocumentfragment.cpp @@ -303,7 +303,7 @@ QTextDocumentFragment::QTextDocumentFragment(const QTextDocument *document) Creates a QTextDocumentFragment from the \a{cursor}'s selection. If the cursor doesn't have a selection, the created fragment is empty. - \sa isEmpty() QTextCursor::selection() + \sa isEmpty(), QTextCursor::selection() */ QTextDocumentFragment::QTextDocumentFragment(const QTextCursor &cursor) : d(0) diff --git a/src/gui/text/qtextformat.cpp b/src/gui/text/qtextformat.cpp index bb3d897ebe..6d9eeab660 100644 --- a/src/gui/text/qtextformat.cpp +++ b/src/gui/text/qtextformat.cpp @@ -908,7 +908,8 @@ QTextTableCellFormat QTextFormat::toTableCellFormat() const Returns the value of the property specified by \a propertyId. If the property isn't of QTextFormat::Bool type, false is returned instead. - \sa setProperty() intProperty() doubleProperty() stringProperty() colorProperty() lengthProperty() lengthVectorProperty() Property + \sa setProperty(), intProperty(), doubleProperty(), stringProperty(), colorProperty(), + lengthProperty(), lengthVectorProperty(), Property */ bool QTextFormat::boolProperty(int propertyId) const { @@ -924,7 +925,8 @@ bool QTextFormat::boolProperty(int propertyId) const Returns the value of the property specified by \a propertyId. If the property is not of QTextFormat::Integer type, 0 is returned instead. - \sa setProperty() boolProperty() doubleProperty() stringProperty() colorProperty() lengthProperty() lengthVectorProperty() Property + \sa setProperty(), boolProperty(), doubleProperty(), stringProperty(), colorProperty(), + lengthProperty(), lengthVectorProperty(), Property */ int QTextFormat::intProperty(int propertyId) const { @@ -944,7 +946,8 @@ int QTextFormat::intProperty(int propertyId) const property isn't of QVariant::Double or QMetaType::Float type, 0 is returned instead. - \sa setProperty() boolProperty() intProperty() stringProperty() colorProperty() lengthProperty() lengthVectorProperty() Property + \sa setProperty(), boolProperty(), intProperty(), stringProperty(), colorProperty(), + lengthProperty(), lengthVectorProperty(), Property */ qreal QTextFormat::doubleProperty(int propertyId) const { @@ -961,7 +964,8 @@ qreal QTextFormat::doubleProperty(int propertyId) const property isn't of QVariant::String type, an empty string is returned instead. - \sa setProperty() boolProperty() intProperty() doubleProperty() colorProperty() lengthProperty() lengthVectorProperty() Property + \sa setProperty(), boolProperty(), intProperty(), doubleProperty(), colorProperty(), + lengthProperty(), lengthVectorProperty(), Property */ QString QTextFormat::stringProperty(int propertyId) const { @@ -996,7 +1000,8 @@ QColor QTextFormat::colorProperty(int propertyId) const property isn't of QVariant::Pen type, Qt::NoPen is returned instead. - \sa setProperty() boolProperty() intProperty() doubleProperty() stringProperty() lengthProperty() lengthVectorProperty() Property + \sa setProperty(), boolProperty(), intProperty(), doubleProperty(), stringProperty(), + lengthProperty(), lengthVectorProperty(), Property */ QPen QTextFormat::penProperty(int propertyId) const { @@ -1013,7 +1018,8 @@ QPen QTextFormat::penProperty(int propertyId) const property isn't of QVariant::Brush type, Qt::NoBrush is returned instead. - \sa setProperty() boolProperty() intProperty() doubleProperty() stringProperty() lengthProperty() lengthVectorProperty() Property + \sa setProperty(), boolProperty(), intProperty(), doubleProperty(), stringProperty(), + lengthProperty(), lengthVectorProperty(), Property */ QBrush QTextFormat::brushProperty(int propertyId) const { @@ -1028,7 +1034,8 @@ QBrush QTextFormat::brushProperty(int propertyId) const /*! Returns the value of the property given by \a propertyId. - \sa setProperty() boolProperty() intProperty() doubleProperty() stringProperty() colorProperty() lengthVectorProperty() Property + \sa setProperty(), boolProperty(), intProperty(), doubleProperty(), stringProperty(), + colorProperty(), lengthVectorProperty(), Property */ QTextLength QTextFormat::lengthProperty(int propertyId) const { @@ -1042,7 +1049,8 @@ QTextLength QTextFormat::lengthProperty(int propertyId) const property isn't of QTextFormat::LengthVector type, an empty length vector is returned instead. - \sa setProperty() boolProperty() intProperty() doubleProperty() stringProperty() colorProperty() lengthProperty() Property + \sa setProperty(), boolProperty(), intProperty(), doubleProperty(), stringProperty(), + colorProperty(), lengthProperty(), Property */ QVector<QTextLength> QTextFormat::lengthVectorProperty(int propertyId) const { @@ -1091,7 +1099,7 @@ void QTextFormat::setProperty(int propertyId, const QVariant &value) /*! Sets the value of the property given by \a propertyId to \a value. - \sa lengthVectorProperty() Property + \sa lengthVectorProperty(), Property */ void QTextFormat::setProperty(int propertyId, const QVector<QTextLength> &value) { @@ -1173,7 +1181,7 @@ void QTextFormat::setObjectIndex(int o) Returns true if the text format has a property with the given \a propertyId; otherwise returns false. - \sa properties() Property + \sa properties(), Property */ bool QTextFormat::hasProperty(int propertyId) const { @@ -1183,7 +1191,7 @@ bool QTextFormat::hasProperty(int propertyId) const /* Returns the property type for the given \a propertyId. - \sa hasProperty() allPropertyIds() Property + \sa hasProperty(), allPropertyIds(), Property */ /*! @@ -1267,7 +1275,7 @@ bool QTextFormat::operator==(const QTextFormat &rhs) const setAnchorHref() and setAnchorNames() functions are used to specify the information about the hyperlink's destination and the anchor's name. - \sa QTextFormat QTextBlockFormat QTextTableFormat QTextListFormat + \sa QTextFormat, QTextBlockFormat, QTextTableFormat, QTextListFormat */ /*! @@ -1638,7 +1646,7 @@ void QTextCharFormat::setUnderlineStyle(UnderlineStyle style) Sets the foreground brush to the specified \a brush. The foreground brush is mostly used to render text. - \sa foreground() clearForeground() setBackground() + \sa foreground(), clearForeground(), setBackground() */ @@ -1648,7 +1656,7 @@ void QTextCharFormat::setUnderlineStyle(UnderlineStyle style) Returns the brush used to render foreground details, such as text, frame outlines, and table borders. - \sa setForeground() clearForeground() background() + \sa setForeground(), clearForeground(), background() */ /*! @@ -1657,7 +1665,7 @@ void QTextCharFormat::setUnderlineStyle(UnderlineStyle style) Clears the brush used to paint the document's foreground. The default brush will be used. - \sa foreground() setForeground() clearBackground() + \sa foreground(), setForeground(), clearBackground() */ @@ -1683,7 +1691,7 @@ void QTextCharFormat::setUnderlineStyle(UnderlineStyle style) Returns true if the text is formatted as an anchor; otherwise returns false. - \sa setAnchor() setAnchorHref() setAnchorNames() + \sa setAnchor(), setAnchorHref(), setAnchorNames() */ @@ -2044,7 +2052,7 @@ QList<QTextOption::Tab> QTextBlockFormat::tabPositions() const Sets the paragraph's top \a margin. - \sa topMargin() setBottomMargin() setLeftMargin() setRightMargin() + \sa topMargin(), setBottomMargin(), setLeftMargin(), setRightMargin() */ @@ -2053,7 +2061,7 @@ QList<QTextOption::Tab> QTextBlockFormat::tabPositions() const Returns the paragraph's top margin. - \sa setTopMargin() bottomMargin() + \sa setTopMargin(), bottomMargin() */ @@ -2062,7 +2070,7 @@ QList<QTextOption::Tab> QTextBlockFormat::tabPositions() const Sets the paragraph's bottom \a margin. - \sa bottomMargin() setTopMargin() setLeftMargin() setRightMargin() + \sa bottomMargin(), setTopMargin(), setLeftMargin(), setRightMargin() */ @@ -2071,7 +2079,7 @@ QList<QTextOption::Tab> QTextBlockFormat::tabPositions() const Returns the paragraph's bottom margin. - \sa setBottomMargin() topMargin() + \sa setBottomMargin(), topMargin() */ @@ -2081,7 +2089,7 @@ QList<QTextOption::Tab> QTextBlockFormat::tabPositions() const Sets the paragraph's left \a margin. Indentation can be applied separately with setIndent(). - \sa leftMargin() setRightMargin() setTopMargin() setBottomMargin() + \sa leftMargin(), setRightMargin(), setTopMargin(), setBottomMargin() */ @@ -2090,7 +2098,7 @@ QList<QTextOption::Tab> QTextBlockFormat::tabPositions() const Returns the paragraph's left margin. - \sa setLeftMargin() rightMargin() indent() + \sa setLeftMargin(), rightMargin(), indent() */ @@ -2099,7 +2107,7 @@ QList<QTextOption::Tab> QTextBlockFormat::tabPositions() const Sets the paragraph's right \a margin. - \sa rightMargin() setLeftMargin() setTopMargin() setBottomMargin() + \sa rightMargin(), setLeftMargin(), setTopMargin(), setBottomMargin() */ @@ -2108,7 +2116,7 @@ QList<QTextOption::Tab> QTextBlockFormat::tabPositions() const Returns the paragraph's right margin. - \sa setRightMargin() leftMargin() + \sa setRightMargin(), leftMargin() */ @@ -2119,7 +2127,7 @@ QList<QTextOption::Tab> QTextBlockFormat::tabPositions() const line of a paragraph to be indented differently to the other lines, enhancing the readability of the text. - \sa textIndent() setLeftMargin() setRightMargin() setTopMargin() setBottomMargin() + \sa textIndent(), setLeftMargin(), setRightMargin(), setTopMargin(), setBottomMargin() */ @@ -2140,7 +2148,7 @@ QList<QTextOption::Tab> QTextBlockFormat::tabPositions() const The \a indentation is an integer that is multiplied with the document-wide standard indent, resulting in the actual indent of the paragraph. - \sa indent() QTextDocument::indentWidth() + \sa indent(), QTextDocument::indentWidth() */ @@ -2325,7 +2333,7 @@ QTextListFormat::QTextListFormat(const QTextFormat &fmt) Sets the list format's \a style. - \sa style() Style + \sa style(), Style */ /*! @@ -2333,7 +2341,7 @@ QTextListFormat::QTextListFormat(const QTextFormat &fmt) Returns the list format's style. - \sa setStyle() Style + \sa setStyle(), Style */ @@ -2432,7 +2440,7 @@ QTextListFormat::QTextListFormat(const QTextFormat &fmt) The validity of a QTextFrameFormat object can be determined with the isValid() function. - \sa QTextFrame QTextBlockFormat + \sa QTextFrame, QTextBlockFormat */ /*! @@ -2444,7 +2452,7 @@ QTextListFormat::QTextListFormat(const QTextFormat &fmt) \value FloatLeft \value FloatRight - \sa position() CssFloat + \sa position(), CssFloat */ /*! @@ -2465,7 +2473,7 @@ QTextListFormat::QTextListFormat(const QTextFormat &fmt) \value BorderStyle_Inset \value BorderStyle_Outset - \sa borderStyle() FrameBorderStyle + \sa borderStyle(), FrameBorderStyle */ /*! @@ -2768,7 +2776,7 @@ qreal QTextFrameFormat::rightMargin() const with a vector containing new constraints. If no constraints are required, clearColumnWidthConstraints() can be used to remove them. - \sa QTextTable QTextTableCell QTextLength + \sa QTextTable, QTextTableCell, QTextLength */ /*! @@ -2825,7 +2833,7 @@ QTextTableFormat::QTextTableFormat(const QTextFormat &fmt) Clears the column width constraints for the table. - \sa columnWidthConstraints() setColumnWidthConstraints() + \sa columnWidthConstraints(), setColumnWidthConstraints() */ /*! @@ -2833,7 +2841,7 @@ QTextTableFormat::QTextTableFormat(const QTextFormat &fmt) Sets the column width \a constraints for the table. - \sa columnWidthConstraints() clearColumnWidthConstraints() + \sa columnWidthConstraints(), clearColumnWidthConstraints() */ /*! @@ -2913,7 +2921,7 @@ QTextTableFormat::QTextTableFormat(const QTextFormat &fmt) Sets the brush use to paint the document's background to the \a brush specified. - \sa background() clearBackground() setForeground() + \sa background(), clearBackground(), setForeground() */ /*! @@ -2921,7 +2929,7 @@ QTextTableFormat::QTextTableFormat(const QTextFormat &fmt) Returns the brush used to paint the document's background. - \sa setBackground() clearBackground() foreground() + \sa setBackground(), clearBackground(), foreground() */ /*! @@ -2930,7 +2938,7 @@ QTextTableFormat::QTextTableFormat(const QTextFormat &fmt) Clears the brush used to paint the document's background. The default brush will be used. - \sa background() setBackground() clearForeground() + \sa background(), setBackground(), clearForeground() */ @@ -3006,7 +3014,7 @@ QTextImageFormat::QTextImageFormat(const QTextFormat &fmt) Sets the \a width of the rectangle occupied by the image. - \sa width() setHeight() + \sa width(), setHeight() */ @@ -3015,7 +3023,7 @@ QTextImageFormat::QTextImageFormat(const QTextFormat &fmt) Returns the width of the rectangle occupied by the image. - \sa height() setWidth() + \sa height(), setWidth() */ @@ -3024,7 +3032,7 @@ QTextImageFormat::QTextImageFormat(const QTextFormat &fmt) Sets the \a height of the rectangle occupied by the image. - \sa height() setWidth() + \sa height(), setWidth() */ @@ -3033,7 +3041,7 @@ QTextImageFormat::QTextImageFormat(const QTextFormat &fmt) Returns the height of the rectangle occupied by the image. - \sa width() setHeight() + \sa width(), setHeight() */ /*! @@ -3262,7 +3270,7 @@ QTextTableCellFormat::QTextTableCellFormat(const QTextFormat &fmt) setRightPadding(), setTopPadding(), and setBottomPadding(). All the paddings can be set at once using setPadding(). - \sa QTextFormat QTextBlockFormat QTextTableFormat QTextCharFormat + \sa QTextFormat, QTextBlockFormat, QTextTableFormat, QTextCharFormat */ // ------------------------------------------------------ diff --git a/src/gui/text/qtextlist.cpp b/src/gui/text/qtextlist.cpp index 82d744d654..cce442c4d7 100644 --- a/src/gui/text/qtextlist.cpp +++ b/src/gui/text/qtextlist.cpp @@ -139,7 +139,7 @@ int QTextList::count() const /*! Returns the \a{i}-th text block in the list. - \sa count() itemText() + \sa count(), itemText() */ QTextBlock QTextList::item(int i) const { diff --git a/src/gui/text/qtextobject.cpp b/src/gui/text/qtextobject.cpp index d4e9c7d12c..af98642abd 100644 --- a/src/gui/text/qtextobject.cpp +++ b/src/gui/text/qtextobject.cpp @@ -115,7 +115,7 @@ QTextObject::~QTextObject() /*! Returns the text object's format. - \sa setFormat() document() + \sa setFormat(), document() */ QTextFormat QTextObject::format() const { @@ -201,7 +201,7 @@ QTextDocumentPrivate *QTextObject::docHandle() const for example, the top-level items in a multi-level list will be separated by the items in lower levels of the list. - \sa QTextBlock QTextDocument + \sa QTextBlock, QTextDocument */ void QTextBlockGroupPrivate::markBlocksDirty() @@ -343,7 +343,7 @@ QTextFrameLayoutData::~QTextFrameLayoutData() QTextFrame::iterator class: this provides read-only access to its internal list of text blocks and child frames. - \sa QTextCursor QTextDocument + \sa QTextCursor, QTextDocument */ /*! @@ -357,7 +357,7 @@ QTextFrameLayoutData::~QTextFrameLayoutData() Returns the parent frame of the current frame. - \sa currentFrame() QTextFrame::parentFrame() + \sa currentFrame(), QTextFrame::parentFrame() */ /*! @@ -447,7 +447,7 @@ QList<QTextFrame *> QTextFrame::childFrames() const Returns the frame's parent frame. If the frame is the root frame of a document, this will return 0. - \sa childFrames() QTextDocument::rootFrame() + \sa childFrames(), QTextDocument::rootFrame() */ QTextFrame *QTextFrame::parentFrame() const { @@ -459,7 +459,7 @@ QTextFrame *QTextFrame::parentFrame() const /*! Returns the first cursor position inside the frame. - \sa lastCursorPosition() firstPosition() lastPosition() + \sa lastCursorPosition(), firstPosition(), lastPosition() */ QTextCursor QTextFrame::firstCursorPosition() const { @@ -470,7 +470,7 @@ QTextCursor QTextFrame::firstCursorPosition() const /*! Returns the last cursor position inside the frame. - \sa firstCursorPosition() firstPosition() lastPosition() + \sa firstCursorPosition(), firstPosition(), lastPosition() */ QTextCursor QTextFrame::lastCursorPosition() const { @@ -481,7 +481,7 @@ QTextCursor QTextFrame::lastCursorPosition() const /*! Returns the first document position inside the frame. - \sa lastPosition() firstCursorPosition() lastCursorPosition() + \sa lastPosition(), firstCursorPosition(), lastCursorPosition() */ int QTextFrame::firstPosition() const { @@ -494,7 +494,7 @@ int QTextFrame::firstPosition() const /*! Returns the last document position inside the frame. - \sa firstPosition() firstCursorPosition() lastCursorPosition() + \sa firstPosition(), firstCursorPosition(), lastCursorPosition() */ int QTextFrame::lastPosition() const { @@ -718,7 +718,7 @@ QTextBlock QTextFrame::iterator::currentBlock() const /*! Moves the iterator to the next frame or block. - \sa currentBlock() currentFrame() + \sa currentBlock(), currentFrame() */ QTextFrame::iterator &QTextFrame::iterator::operator++() { @@ -756,7 +756,7 @@ QTextFrame::iterator &QTextFrame::iterator::operator++() /*! Moves the iterator to the previous frame or block. - \sa currentBlock() currentFrame() + \sa currentBlock(), currentFrame() */ QTextFrame::iterator &QTextFrame::iterator::operator--() { @@ -864,7 +864,7 @@ QTextBlockUserData::~QTextBlockUserData() \img qtextblock-sequence.png - \sa QTextBlockFormat QTextCharFormat QTextFragment + \sa QTextBlockFormat, QTextCharFormat, QTextFragment */ /*! @@ -1027,7 +1027,7 @@ int QTextBlock::position() const \note The length returned includes all formatting characters, for example, newline. - \sa text() charFormat() blockFormat() + \sa text(), charFormat(), blockFormat() */ int QTextBlock::length() const { @@ -1195,7 +1195,7 @@ Qt::LayoutDirection QTextBlock::textDirection() const /*! Returns the block's contents as plain text. - \sa length() charFormat() blockFormat() + \sa length(), charFormat(), blockFormat() */ QString QTextBlock::text() const { @@ -1468,7 +1468,7 @@ QTextBlock::iterator QTextBlock::begin() const Returns a text block iterator pointing to the end of the text block. - \sa begin() next() previous() + \sa begin(), next(), previous() */ QTextBlock::iterator QTextBlock::end() const { @@ -1489,7 +1489,7 @@ QTextBlock::iterator QTextBlock::end() const Note that the next block may be in a different frame or table to this block. - \sa previous() begin() end() + \sa previous(), begin(), end() */ QTextBlock QTextBlock::next() const { @@ -1505,7 +1505,7 @@ QTextBlock QTextBlock::next() const Note that the next block may be in a different frame or table to this block. - \sa next() begin() end() + \sa next(), begin(), end() */ QTextBlock QTextBlock::previous() const { diff --git a/src/gui/text/qtexttable.cpp b/src/gui/text/qtexttable.cpp index a9866187d3..5589ffeb71 100644 --- a/src/gui/text/qtexttable.cpp +++ b/src/gui/text/qtexttable.cpp @@ -76,7 +76,7 @@ QT_BEGIN_NAMESPACE contents. The firstCursorPosition() and lastCursorPosition() functions are used to obtain the extent of the cell in the document. - \sa QTextTable QTextTableFormat + \sa QTextTable, QTextTableFormat */ /*! @@ -583,7 +583,7 @@ QTextTable::~QTextTable() Returns the table cell at the given \a row and \a column in the table. - \sa columns() rows() + \sa columns(), rows() */ QTextTableCell QTextTable::cellAt(int row, int col) const { @@ -639,7 +639,7 @@ QTextTableCell QTextTable::cellAt(const QTextCursor &c) const Resizes the table to contain the required number of \a rows and \a columns. - \sa insertRows() insertColumns() removeRows() removeColumns() + \sa insertRows(), insertColumns(), removeRows(), removeColumns() */ void QTextTable::resize(int rows, int cols) { @@ -673,7 +673,7 @@ void QTextTable::resize(int rows, int cols) Inserts a number of \a rows before the row with the specified \a index. - \sa resize() insertColumns() removeRows() removeColumns() appendRows() appendColumns() + \sa resize(), insertColumns(), removeRows(), removeColumns(), appendRows(), appendColumns() */ void QTextTable::insertRows(int pos, int num) { @@ -735,7 +735,7 @@ void QTextTable::insertRows(int pos, int num) Inserts a number of \a columns before the column with the specified \a index. - \sa insertRows() resize() removeRows() removeColumns() appendRows() appendColumns() + \sa insertRows(), resize(), removeRows(), removeColumns(), appendRows(), appendColumns() */ void QTextTable::insertColumns(int pos, int num) { @@ -816,7 +816,7 @@ void QTextTable::insertColumns(int pos, int num) \since 4.5 Appends \a count rows at the bottom of the table. - \sa insertColumns() insertRows() resize() removeRows() removeColumns() appendColumns() + \sa insertColumns(), insertRows(), resize(), removeRows(), removeColumns(), appendColumns() */ void QTextTable::appendRows(int count) { @@ -827,7 +827,7 @@ void QTextTable::appendRows(int count) \since 4.5 Appends \a count columns at the right side of the table. - \sa insertColumns() insertRows() resize() removeRows() removeColumns() appendRows() + \sa insertColumns(), insertRows(), resize(), removeRows(), removeColumns(), appendRows() */ void QTextTable::appendColumns(int count) { @@ -839,7 +839,7 @@ void QTextTable::appendColumns(int count) Removes a number of \a rows starting with the row at the specified \a index. - \sa insertRows(), insertColumns(), resize(), removeColumns() appendRows() appendColumns() + \sa insertRows(), insertColumns(), resize(), removeColumns(), appendRows(), appendColumns() */ void QTextTable::removeRows(int pos, int num) { @@ -901,7 +901,7 @@ void QTextTable::removeRows(int pos, int num) Removes a number of \a columns starting with the column at the specified \a index. - \sa insertRows() insertColumns() removeRows() resize() appendRows() appendColumns() + \sa insertRows(), insertColumns(), removeRows(), resize(), appendRows(), appendColumns() */ void QTextTable::removeColumns(int pos, int num) { diff --git a/src/gui/util/qdesktopservices.cpp b/src/gui/util/qdesktopservices.cpp index 5e83e7cc00..35494d25fa 100644 --- a/src/gui/util/qdesktopservices.cpp +++ b/src/gui/util/qdesktopservices.cpp @@ -269,7 +269,7 @@ void QDesktopServices::unsetUrlHandler(const QString &scheme) \value CacheLocation Returns a directory location where user-specific non-essential (cached) data should be written. - \sa storageLocation() displayName() + \sa storageLocation(), displayName() */ /*! diff --git a/src/gui/util/qvalidator.cpp b/src/gui/util/qvalidator.cpp index 84a5b4c54c..f0d795b57d 100644 --- a/src/gui/util/qvalidator.cpp +++ b/src/gui/util/qvalidator.cpp @@ -248,7 +248,7 @@ QLocale QValidator::locale() const locale set with QLocale::setDefault(). If a default locale has not been set, it is the operating system's locale. - \sa locale() QLocale::setDefault() + \sa locale(), QLocale::setDefault() */ void QValidator::setLocale(const QLocale &locale) { |