From 358f78f215faf9dab433a279d87007f52fbe3c71 Mon Sep 17 00:00:00 2001 From: Giuseppe D'Angelo Date: Fri, 11 May 2012 01:47:46 +0100 Subject: [PATCH] QtGui: remove \link usages Change-Id: Ib8cca14a8fa35fbc631bfea9b4873225eac3677f Reviewed-by: Casper van Donderen --- src/gui/accessible/qaccessible2.cpp | 18 ++++---- src/gui/doc/src/external-resources.qdoc | 47 +++++++++++++++++++++ src/gui/doc/src/paintsystem.qdoc | 3 +- src/gui/image/qpicture.cpp | 3 +- src/gui/kernel/qcursor.cpp | 3 +- src/gui/kernel/qkeysequence.cpp | 7 ++- src/gui/kernel/qpalette.cpp | 4 +- src/gui/kernel/qwindow.cpp | 4 +- src/gui/opengl/qopenglframebufferobject.cpp | 8 ++-- src/gui/painting/qregion.cpp | 4 +- src/gui/text/qfont.cpp | 25 ++++++----- src/gui/text/qfontmetrics.cpp | 12 +++--- src/gui/text/qtextdocument.cpp | 6 +-- 13 files changed, 92 insertions(+), 52 deletions(-) create mode 100644 src/gui/doc/src/external-resources.qdoc diff --git a/src/gui/accessible/qaccessible2.cpp b/src/gui/accessible/qaccessible2.cpp index 581568b32d..da053db3d0 100644 --- a/src/gui/accessible/qaccessible2.cpp +++ b/src/gui/accessible/qaccessible2.cpp @@ -56,7 +56,7 @@ QT_BEGIN_NAMESPACE \brief The QAccessible2 namespace defines constants relating to IAccessible2-based interfaces - \link http://www.linux-foundation.org/en/Accessibility/IAccessible2 IAccessible2 Specification \endlink + \l{IAccessible2 Specification} */ /*! @@ -76,7 +76,7 @@ QT_BEGIN_NAMESPACE This interface is, for example, implemented for QLineEdit. Editable text objects should also implement \l QAccessibleEditableTextInterface. - \link http://www.linux-foundation.org/en/Accessibility/IAccessible2 IAccessible2 Specification \endlink + \l{IAccessible2 Specification} */ /*! @@ -194,7 +194,7 @@ QT_BEGIN_NAMESPACE \sa QAccessibleInterface - \link http://www.linux-foundation.org/en/Accessibility/IAccessible2 IAccessible2 Specification \endlink + \l{IAccessible2 Specification} */ /*! @@ -257,7 +257,7 @@ QT_BEGIN_NAMESPACE \sa QAccessibleInterface, QAccessibleEditableTextInterface - \link http://www.linux-foundation.org/en/Accessibility/IAccessible2 IAccessible2 Specification \endlink + \l{IAccessible2 Specification} */ /*! @@ -275,7 +275,7 @@ QT_BEGIN_NAMESPACE Usually this interface is implemented by classes that also implement \l QAccessibleInterface. - \link http://www.linux-foundation.org/en/Accessibility/IAccessible2 IAccessible2 Specification \endlink + \l{IAccessible2 Specification} */ /*! @@ -322,7 +322,7 @@ QT_BEGIN_NAMESPACE \brief The QAccessibleImageInterface class implements support for the IAccessibleImage interface. - \link http://www.linux-foundation.org/en/Accessibility/IAccessible2 IAccessible2 Specification \endlink + \l{IAccessible2 Specification} */ /*! @@ -333,7 +333,7 @@ QT_BEGIN_NAMESPACE \brief The QAccessibleTableCellInterface class implements support for the IAccessibleTable2 Cell interface. - \link http://www.linux-foundation.org/en/Accessibility/IAccessible2 IAccessible2 Specification \endlink + \l{IAccessible2 Specification} */ /*! @@ -344,7 +344,7 @@ QT_BEGIN_NAMESPACE \brief The QAccessibleTableInterface class implements support for the IAccessibleTable2 interface. - \link http://www.linux-foundation.org/en/Accessibility/IAccessible2 IAccessible2 Specification \endlink + \l{IAccessible2 Specification} */ @@ -385,7 +385,7 @@ QT_BEGIN_NAMESPACE Most widgets will simply implement \l pressAction(). This is what happens when the widget is activated by being clicked, space pressed or similar. - \link http://www.linux-foundation.org/en/Accessibility/IAccessible2 IAccessible2 Specification \endlink + \l{IAccessible2 Specification} */ /*! diff --git a/src/gui/doc/src/external-resources.qdoc b/src/gui/doc/src/external-resources.qdoc new file mode 100644 index 0000000000..200fc90b46 --- /dev/null +++ b/src/gui/doc/src/external-resources.qdoc @@ -0,0 +1,47 @@ +/**************************************************************************** +** +** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies). +** Contact: http://www.qt-project.org/ +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:FDL$ +** GNU Free Documentation License +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. +** +** Other Usage +** Alternatively, this file may be used in accordance with the terms +** and conditions contained in a signed written agreement between you +** and Nokia. +** +** +** +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + + +/*! + \externalpage http://nwalsh.com/comp.fonts/FAQ/ + \title comp.fonts FAQ +*/ + +/*! + \externalpage http://www.linux-foundation.org/en/Accessibility/IAccessible2 + \title IAccessible2 Specification +*/ + +/*! + \externalpage http://czyborra.com/ + \title Roman Czyborra's +*/ + +/*! + \externalpage http://www.xfree86.org/4.3.0/Xcursor.3.html + \title Xcursor +*/ diff --git a/src/gui/doc/src/paintsystem.qdoc b/src/gui/doc/src/paintsystem.qdoc index 4b33e4fed3..b5fd864e9d 100644 --- a/src/gui/doc/src/paintsystem.qdoc +++ b/src/gui/doc/src/paintsystem.qdoc @@ -32,8 +32,7 @@ \brief Classes that provide support for painting. - See also this introduction to the \link coordsys.html Qt - coordinate system. \endlink + See also this introduction to the \l{coordsys.html}{Qt coordinate system.} */ /*! diff --git a/src/gui/image/qpicture.cpp b/src/gui/image/qpicture.cpp index dde039f554..fa5cf79bf2 100644 --- a/src/gui/image/qpicture.cpp +++ b/src/gui/image/qpicture.cpp @@ -1833,8 +1833,7 @@ QList QPictureIO::outputFormats() Setting the picture file format string is optional. - Note that this function does \e not set the \link format() - format\endlink used to read the picture. If you need that + Note that this function does \e not set the \l{format()}{format} used to read the picture. If you need that information, use the pictureFormat() static functions. Example: diff --git a/src/gui/kernel/qcursor.cpp b/src/gui/kernel/qcursor.cpp index 476d3a449b..4798dc53a7 100644 --- a/src/gui/kernel/qcursor.cpp +++ b/src/gui/kernel/qcursor.cpp @@ -93,8 +93,7 @@ QT_BEGIN_NAMESPACE \section1 A Note for X11 Users - On X11, Qt supports the \link - http://www.xfree86.org/4.3.0/Xcursor.3.html Xcursor\endlink + On X11, Qt supports the \l{Xcursor}{Xcursor} library, which allows for full color icon themes. The table below shows the cursor name used for each Qt::CursorShape value. If a cursor cannot be found using the name shown below, a standard X11 diff --git a/src/gui/kernel/qkeysequence.cpp b/src/gui/kernel/qkeysequence.cpp index 4eeac1a4dd..b71a803867 100644 --- a/src/gui/kernel/qkeysequence.cpp +++ b/src/gui/kernel/qkeysequence.cpp @@ -933,8 +933,7 @@ QKeySequence::QKeySequence() \a key should be in NativeText format. - This constructor is typically used with \link QObject::tr() tr - \endlink(), so that shortcut keys can be replaced in + This constructor is typically used with \l{QObject::tr()}{tr}(), so that shortcut keys can be replaced in translations: \snippet code/src_gui_kernel_qkeysequence.cpp 2 @@ -1693,7 +1692,7 @@ QKeySequence QKeySequence::fromString(const QString &str, SequenceFormat format) Writes the key \a sequence to the \a stream. - \sa \link datastreamformat.html Format of the QDataStream operators \endlink + \sa{Serializing Qt Data Types}{Format of the QDataStream operators} */ QDataStream &operator<<(QDataStream &s, const QKeySequence &keysequence) { @@ -1716,7 +1715,7 @@ QDataStream &operator<<(QDataStream &s, const QKeySequence &keysequence) Reads a key sequence from the \a stream into the key \a sequence. - \sa \link datastreamformat.html Format of the QDataStream operators \endlink + \sa{Serializing Qt Data Types}{Format of the QDataStream operators} */ QDataStream &operator>>(QDataStream &s, QKeySequence &keysequence) { diff --git a/src/gui/kernel/qpalette.cpp b/src/gui/kernel/qpalette.cpp index 71d5427a37..73515f6f17 100644 --- a/src/gui/kernel/qpalette.cpp +++ b/src/gui/kernel/qpalette.cpp @@ -925,7 +925,7 @@ static const int oldRoles[7] = { QPalette::Foreground, QPalette::Background, QPa Writes the palette, \a p to the stream \a s and returns a reference to the stream. - \sa \link datastreamformat.html Format of the QDataStream operators \endlink + \sa{Serializing Qt Data Types}{Format of the QDataStream operators} */ QDataStream &operator<<(QDataStream &s, const QPalette &p) @@ -963,7 +963,7 @@ static void readV1ColorGroup(QDataStream &s, QPalette &pal, QPalette::ColorGroup Reads a palette from the stream, \a s into the palette \a p, and returns a reference to the stream. - \sa \link datastreamformat.html Format of the QDataStream operators \endlink + \sa{Serializing Qt Data Types}{Format of the QDataStream operators} */ QDataStream &operator>>(QDataStream &s, QPalette &p) diff --git a/src/gui/kernel/qwindow.cpp b/src/gui/kernel/qwindow.cpp index 94e8979ca5..5262b6f8ef 100644 --- a/src/gui/kernel/qwindow.cpp +++ b/src/gui/kernel/qwindow.cpp @@ -1695,8 +1695,8 @@ void QWindowPrivate::maybeQuitOnLastWindowClosed() \brief the cursor shape for this window The mouse cursor will assume this shape when it is over this - window, unless an override cursor is set. See the \link - Qt::CursorShape list of predefined cursor objects\endlink for a + window, unless an override cursor is set. + See the \l{Qt::CursorShape}{list of predefined cursor objects} for a range of useful shapes. By default, this property contains a cursor with the Qt::ArrowCursor diff --git a/src/gui/opengl/qopenglframebufferobject.cpp b/src/gui/opengl/qopenglframebufferobject.cpp index cc5750490d..ea75dd4cdf 100644 --- a/src/gui/opengl/qopenglframebufferobject.cpp +++ b/src/gui/opengl/qopenglframebufferobject.cpp @@ -83,10 +83,10 @@ QT_BEGIN_NAMESPACE A framebuffer object has several characteristics: \list - \li \link setSamples() Number of samples per pixels.\endlink - \li \link setAttachment() Depth and/or stencil attachments.\endlink - \li \link setTextureTarget() Texture target.\endlink - \li \link setInternalTextureFormat() Internal texture format.\endlink + \li \l{setSamples()}{Number of samples per pixels.} + \li \l{setAttachment()}{Depth and/or stencil attachments.} + \li \l{setTextureTarget()}{Texture target.} + \li \l{setInternalTextureFormat()}{Internal texture format.} \endlist Note that the desired attachments or number of samples per pixels might not diff --git a/src/gui/painting/qregion.cpp b/src/gui/painting/qregion.cpp index f250150b06..8ecb122762 100644 --- a/src/gui/painting/qregion.cpp +++ b/src/gui/painting/qregion.cpp @@ -383,7 +383,7 @@ void QRegion::exec(const QByteArray &buffer, int ver, QDataStream::ByteOrder byt Writes the region \a r to the stream \a s and returns a reference to the stream. - \sa \link datastreamformat.html Format of the QDataStream operators \endlink + \sa{Serializing Qt Data Types}{Format of the QDataStream operators} */ QDataStream &operator<<(QDataStream &s, const QRegion &r) @@ -416,7 +416,7 @@ QDataStream &operator<<(QDataStream &s, const QRegion &r) Reads a region from the stream \a s into \a r and returns a reference to the stream. - \sa \link datastreamformat.html Format of the QDataStream operators \endlink + \sa{Serializing Qt Data Types}{Format of the QDataStream operators} */ QDataStream &operator>>(QDataStream &s, QRegion &r) diff --git a/src/gui/text/qfont.cpp b/src/gui/text/qfont.cpp index 753fe5670f..961ac8e64c 100644 --- a/src/gui/text/qfont.cpp +++ b/src/gui/text/qfont.cpp @@ -382,7 +382,7 @@ QFontEngineData::~QFontEngineData() QFontInfo object. If the requested font family is unavailable you can influence the - \link #fontmatching font matching algorithm\endlink by choosing a + \l{#fontmatching}{font matching algorithm} by choosing a particular \l{QFont::StyleHint} and \l{QFont::StyleStrategy} with setStyleHint(). The default family (corresponding to the current style hint) is returned by defaultFamily(). @@ -484,9 +484,9 @@ QFontEngineData::~QFontEngineData() \snippet code/src_gui_text_qfont.cpp 4 For more general information on fonts, see the - \link http://nwalsh.com/comp.fonts/FAQ/ comp.fonts FAQ.\endlink + \l{comp.fonts FAQ}{comp.fonts FAQ}. Information on encodings can be found from - \link http://czyborra.com/ Roman Czyborra's\endlink page. + \l{Roman Czyborra's} page. \sa QFontComboBox, QFontMetrics, QFontInfo, QFontDatabase, {Character Map Example} */ @@ -626,7 +626,7 @@ QFontEngineData::~QFontEngineData() It is theoretically possible that there really isn't a lastResortFont() in which case Qt will abort with an error message. We have not been able to identify a case where this - happens. Please \link bughowto.html report it as a bug\endlink if + happens. Please \l{bughowto.html}{report it as a bug} if it does, preferably with a list of the fonts you have installed. \sa lastResortFamily(), rawName() @@ -1106,8 +1106,8 @@ void QFont::setWeight(int weight) /*! \fn bool QFont::bold() const - Returns true if weight() is a value greater than \link Weight - QFont::Normal \endlink; otherwise returns false. + Returns true if weight() is a value greater than + \l{Weight}{QFont::Normal}; otherwise returns false. \sa weight(), setBold(), QFontInfo::bold() */ @@ -1115,9 +1115,9 @@ void QFont::setWeight(int weight) /*! \fn void QFont::setBold(bool enable) - If \a enable is true sets the font's weight to \link Weight - QFont::Bold \endlink; otherwise sets the weight to \link Weight - QFont::Normal\endlink. + If \a enable is true sets the font's weight to + \l{Weight}{QFont::Bold}; + otherwise sets the weight to \l{Weight}{QFont::Normal}. For finer boldness control use setWeight(). @@ -2097,7 +2097,7 @@ void QFont::cacheStatistics() Writes the font \a font to the data stream \a s. (toString() writes to a text stream.) - \sa \link datastreamformat.html Format of the QDataStream operators \endlink + \sa{Serializing Qt Data Types}{Format of the QDataStream operators} */ QDataStream &operator<<(QDataStream &s, const QFont &font) { @@ -2148,7 +2148,7 @@ QDataStream &operator<<(QDataStream &s, const QFont &font) Reads the font \a font from the data stream \a s. (fromString() reads from a text stream.) - \sa \link datastreamformat.html Format of the QDataStream operators \endlink + \sa{Serializing Qt Data Types}{Format of the QDataStream operators} */ QDataStream &operator>>(QDataStream &s, QFont &font) { @@ -2273,8 +2273,7 @@ QDataStream &operator>>(QDataStream &s, QFont &font) Constructs a font info object for \a font. The font must be screen-compatible, i.e. a font you use when - drawing text in \link QWidget widgets\endlink or \link QPixmap - pixmaps\endlink, not QPicture or QPrinter. + drawing text in \l{QWidget}{widgets} or \l{QPixmap}{pixmaps}, not QPicture or QPrinter. The font info object holds the information for the font that is passed in the constructor at the time it is created, and is not diff --git a/src/gui/text/qfontmetrics.cpp b/src/gui/text/qfontmetrics.cpp index 141ef64e53..83d51e2e71 100644 --- a/src/gui/text/qfontmetrics.cpp +++ b/src/gui/text/qfontmetrics.cpp @@ -166,7 +166,7 @@ QFontMetrics::QFontMetrics(const QFont &font) The font metrics will be compatible with the paintdevice passed. If the \a paintdevice is 0, the metrics will be screen-compatible, ie. the metrics you get if you use the font for drawing text on a - \link QWidget widgets\endlink or \link QPixmap pixmaps\endlink, + \l{QWidget}{widgets} or \l{QPixmap}{pixmaps}, not on a QPicture or QPrinter. The font metrics object holds the information for the font that is @@ -751,8 +751,8 @@ QRect QFontMetrics::boundingRect(QChar ch) const The bounding rectangle returned by this function is somewhat larger than that calculated by the simpler boundingRect() function. This - function uses the \link minLeftBearing() maximum left \endlink and - \link minRightBearing() right \endlink font bearings as is + function uses the \l{minLeftBearing()}{maximum left} and + \l{minRightBearing()}{right} font bearings as is necessary for multi-line text to align correctly. Also, fontHeight() and lineSpacing() are used to calculate the height, rather than individual character heights. @@ -1027,7 +1027,7 @@ QFontMetricsF::QFontMetricsF(const QFont &font) The font metrics will be compatible with the paintdevice passed. If the \a paintdevice is 0, the metrics will be screen-compatible, ie. the metrics you get if you use the font for drawing text on a - \link QWidget widgets\endlink or \link QPixmap pixmaps\endlink, + \l{QWidget}{widgets} or \l{QPixmap}{pixmaps}, not on a QPicture or QPrinter. The font metrics object holds the information for the font that is @@ -1532,8 +1532,8 @@ QRectF QFontMetricsF::boundingRect(QChar ch) const The bounding rectangle returned by this function is somewhat larger than that calculated by the simpler boundingRect() function. This - function uses the \link minLeftBearing() maximum left \endlink and - \link minRightBearing() right \endlink font bearings as is + function uses the \l{minLeftBearing()}{maximum left} and + \l{minRightBearing()}{right} font bearings as is necessary for multi-line text to align correctly. Also, fontHeight() and lineSpacing() are used to calculate the height, rather than individual character heights. diff --git a/src/gui/text/qtextdocument.cpp b/src/gui/text/qtextdocument.cpp index d0a15859ee..0c5194e9c6 100644 --- a/src/gui/text/qtextdocument.cpp +++ b/src/gui/text/qtextdocument.cpp @@ -400,8 +400,7 @@ void QTextDocument::undo(QTextCursor *cursor) /*! \since 4.2 - Redoes the last editing operation on the document if \link - QTextDocument::isRedoAvailable() redo is available\endlink. + Redoes the last editing operation on the document if \l{QTextDocument::isRedoAvailable()}{redo is available}. The provided \a cursor is positioned at the end of the location where the edition operation was redone. @@ -452,8 +451,7 @@ void QTextDocument::undo() /*! \overload - Redoes the last editing operation on the document if \link - QTextDocument::isRedoAvailable() redo is available\endlink. + Redoes the last editing operation on the document if \l{QTextDocument::isRedoAvailable()}{redo is available}. */ void QTextDocument::redo() {