From 16198d963d7a9e5e797a5987140936e5ab913ae5 Mon Sep 17 00:00:00 2001 From: Sze Howe Koh Date: Sun, 3 Nov 2013 11:04:18 +0800 Subject: Doc: Fix broken links MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Task-number: QTBUG-33360 Change-Id: Ic944cb2f575c35ebad64852ef5fc44a50ac03571 Reviewed-by: Jerome Pasion Reviewed-by: Topi Reiniö --- src/corelib/animation/qsequentialanimationgroup.cpp | 2 -- src/corelib/doc/src/custom-types.qdoc | 7 +++---- src/corelib/doc/src/objectmodel/object.qdoc | 3 ++- src/corelib/doc/src/objectmodel/signalsandslots.qdoc | 2 +- src/corelib/doc/src/plugins-howto.qdoc | 2 +- src/corelib/doc/src/threads.qdoc | 4 ++-- src/corelib/kernel/qmath.cpp | 2 -- src/corelib/kernel/qobject.cpp | 4 ++-- src/corelib/tools/qstring.cpp | 8 ++++---- src/corelib/tools/qvector.cpp | 4 ++-- src/gui/image/qimage.cpp | 2 +- src/gui/kernel/qevent.cpp | 15 +++++++-------- src/gui/kernel/qopenglcontext.cpp | 6 +++--- src/gui/kernel/qplatformsystemtrayicon_qpa.cpp | 2 +- src/gui/kernel/qsurfaceformat.cpp | 4 ++-- src/gui/opengl/qopengltexture.cpp | 12 ++++++------ src/gui/painting/qbrush.cpp | 4 ++-- src/gui/painting/qpaintengine_raster.cpp | 16 ++++++---------- src/gui/text/qfontmetrics.cpp | 2 +- src/opengl/qgl.cpp | 2 +- src/sql/models/qsqlrelationaltablemodel.cpp | 2 +- src/widgets/doc/src/widgets-and-layouts/layout.qdoc | 4 ++-- src/widgets/doc/src/widgets-tutorial.qdoc | 2 +- 23 files changed, 51 insertions(+), 60 deletions(-) (limited to 'src') diff --git a/src/corelib/animation/qsequentialanimationgroup.cpp b/src/corelib/animation/qsequentialanimationgroup.cpp index 42debea782..1c84e3dbc9 100644 --- a/src/corelib/animation/qsequentialanimationgroup.cpp +++ b/src/corelib/animation/qsequentialanimationgroup.cpp @@ -303,8 +303,6 @@ QPauseAnimation *QSequentialAnimationGroup::insertPause(int index, int msecs) /*! \property QSequentialAnimationGroup::currentAnimation Returns the animation in the current time. - - \sa currentAnimationChanged() */ QAbstractAnimation *QSequentialAnimationGroup::currentAnimation() const { diff --git a/src/corelib/doc/src/custom-types.qdoc b/src/corelib/doc/src/custom-types.qdoc index cbf347a2f7..ed846aee83 100644 --- a/src/corelib/doc/src/custom-types.qdoc +++ b/src/corelib/doc/src/custom-types.qdoc @@ -155,10 +155,9 @@ The Q_DECLARE_METATYPE() macro and qRegisterMetaType() function documentation contain more detailed information about their uses and limitations. - The \l{Custom Type Example}{Custom Type}, - \l{Custom Type Sending Example}{Custom Type Sending} - and \l{Queued Custom Type Example}{Queued Custom Type} examples show how to - implement a custom type with the features outlined in this document. + The \l{Custom Type Example}{Custom Type} and \l{Queued Custom Type Example} + {Queued Custom Type} examples show how to implement a custom type with the + features outlined in this document. The \l{Debugging Techniques} document provides an overview of the debugging mechanisms discussed above. diff --git a/src/corelib/doc/src/objectmodel/object.qdoc b/src/corelib/doc/src/objectmodel/object.qdoc index 89a781da39..8d24096b7a 100644 --- a/src/corelib/doc/src/objectmodel/object.qdoc +++ b/src/corelib/doc/src/objectmodel/object.qdoc @@ -46,7 +46,8 @@ \li queryable and designable \l{Qt's Property System}{object properties} \li powerful \l{The Event System}{events and event filters} - \li contextual \l{i18n}{string translation for internationalization} + \li contextual \l{Internationalization with Qt}{string translation for + internationalization} \li sophisticated interval driven \l {Timers}{timers} that make it possible to elegantly integrate many tasks in an event-driven GUI \li hierarchical and queryable \l{Object Trees & Ownership}{object diff --git a/src/corelib/doc/src/objectmodel/signalsandslots.qdoc b/src/corelib/doc/src/objectmodel/signalsandslots.qdoc index dd93b80cae..e894d547d0 100644 --- a/src/corelib/doc/src/objectmodel/signalsandslots.qdoc +++ b/src/corelib/doc/src/objectmodel/signalsandslots.qdoc @@ -275,7 +275,7 @@ and slot members, as well as pointers to these functions. The meta-object contains additional information such as the - object's \l{QObject::className()}{class name}. You can + object's \l{QMetaObject::className()}{class name}. You can also check if an object \l{QObject::inherits()}{inherits} a specific class, for example: diff --git a/src/corelib/doc/src/plugins-howto.qdoc b/src/corelib/doc/src/plugins-howto.qdoc index 2dbf1f8141..fb91e431dd 100644 --- a/src/corelib/doc/src/plugins-howto.qdoc +++ b/src/corelib/doc/src/plugins-howto.qdoc @@ -37,7 +37,7 @@ See the \l{How to Create Qt Plugins} page for more information.. - See also the \l{ActiveQt framework} for Windows. + See also the \l{Active Qt} framework for Windows. */ diff --git a/src/corelib/doc/src/threads.qdoc b/src/corelib/doc/src/threads.qdoc index 25276404b0..efed33106a 100644 --- a/src/corelib/doc/src/threads.qdoc +++ b/src/corelib/doc/src/threads.qdoc @@ -606,7 +606,7 @@ putting time-consuming operations in a separate worker thread and displaying the results on screen in the main thread when the worker thread is finished. This is the approach used for - implementing the \l{threads/mandelbrot}{Mandelbrot} and + implementing the \l{Mandelbrot Example} and the \l{network/blockingfortuneclient}{Blocking Fortune Client} example. @@ -738,7 +738,7 @@ QObject::connect() itself is thread-safe. - The \l{threads/mandelbrot}{Mandelbrot} example uses a queued + The \l{Mandelbrot Example} uses a queued connection to communicate between a worker thread and the main thread. To avoid freezing the main thread's event loop (and, as a consequence, the application's user interface), all the diff --git a/src/corelib/kernel/qmath.cpp b/src/corelib/kernel/qmath.cpp index 8f900e2101..b1860fa24a 100644 --- a/src/corelib/kernel/qmath.cpp +++ b/src/corelib/kernel/qmath.cpp @@ -310,8 +310,6 @@ const qreal qt_sine_table[QT_SINE_TABLE_SIZE] = { \brief The header file includes generic math declarations. - The global declarations include \l{functions}. - These functions are partly convenience definitions for basic operations, for instance not available in the Standard Template Library et al. diff --git a/src/corelib/kernel/qobject.cpp b/src/corelib/kernel/qobject.cpp index 8ee43f2e97..c19c3fcbb5 100644 --- a/src/corelib/kernel/qobject.cpp +++ b/src/corelib/kernel/qobject.cpp @@ -566,7 +566,7 @@ void QMetaCallEvent::placeMetaCall(QObject *object) \li When a QObject is moved to another thread, all its children will be automatically moved too. \li moveToThread() will fail if the QObject has a parent. - \li If \l{QObject}s are created within QThread::run(), they cannot + \li If QObjects are created within QThread::run(), they cannot become children of the QThread object because the QThread does not live in the thread that calls QThread::run(). \endlist @@ -4622,7 +4622,7 @@ bool QObjectPrivate::disconnect(const QObject *sender, int signal_index, void ** It can be used to disconnect that connection, or check if the connection was successful - \sa QObject::disconnect + \sa QObject::disconnect() */ /*! diff --git a/src/corelib/tools/qstring.cpp b/src/corelib/tools/qstring.cpp index 0e99a5839c..3976f2cb6f 100644 --- a/src/corelib/tools/qstring.cpp +++ b/src/corelib/tools/qstring.cpp @@ -455,8 +455,8 @@ const QString::Null QString::null = { }; your applications will be easy to translate if you want to expand your application's market at some point. The two main cases where QByteArray is appropriate are when you need to store raw binary - data, and when memory conservation is critical (e.g., with - \l{Qt for Embedded Linux}). + data, and when memory conservation is critical (like in embedded + systems). \tableofcontents @@ -5039,7 +5039,7 @@ int QString::compare_helper(const QChar *data1, int length1, QLatin1String s2, On Mac OS X since Qt 4.3, this function compares according the "Order for sorted lists" setting in the International preferences panel. - \sa compare(), QTextCodec::locale() + \sa compare(), QLocale */ /*! @@ -8450,7 +8450,7 @@ QStringRef QStringRef::appendTo(QString *string) const On Mac OS X, this function compares according the "Order for sorted lists" setting in the International prefereces panel. - \sa compare(), QTextCodec::locale() + \sa compare(), QLocale */ /*! diff --git a/src/corelib/tools/qvector.cpp b/src/corelib/tools/qvector.cpp index b9281c6915..f6276711a7 100644 --- a/src/corelib/tools/qvector.cpp +++ b/src/corelib/tools/qvector.cpp @@ -572,7 +572,7 @@ Provided for compatibility with QList. - \sa remove(int), QList::removeAt(int) + \sa remove(), QList::removeAt() */ /*! \fn int QVector::length() const @@ -597,7 +597,7 @@ Provided for compatibility with QList. - \sa takeFirst(), takeLast(), QList::takeAt(int) + \sa takeFirst(), takeLast(), QList::takeAt() */ /*! \fn void QVector::removeFirst() diff --git a/src/gui/image/qimage.cpp b/src/gui/image/qimage.cpp index 69ff27dc73..d602ed4035 100644 --- a/src/gui/image/qimage.cpp +++ b/src/gui/image/qimage.cpp @@ -3989,7 +3989,7 @@ void qGamma_correct_back_to_linear_cs(QImage *image) The specified image conversion \a flags control how the image data is handled during the conversion process. - \sa {QImage#Image Format}{Image Format} + \sa {Image Formats} */ QImage QImage::convertToFormat(Format format, Qt::ImageConversionFlags flags) const { diff --git a/src/gui/kernel/qevent.cpp b/src/gui/kernel/qevent.cpp index 06fa1f3550..28666085a7 100644 --- a/src/gui/kernel/qevent.cpp +++ b/src/gui/kernel/qevent.cpp @@ -118,7 +118,7 @@ QInputEvent::~QInputEvent() Returns the keyboard modifier flags that existed immediately before the event occurred. - \sa QApplication::keyboardModifiers() + \sa QGuiApplication::keyboardModifiers() */ /*! \fn void QInputEvent::setModifiers(Qt::KeyboardModifiers modifiers) @@ -313,7 +313,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(), windowPos() */ /*! @@ -1005,7 +1005,7 @@ QKeyEvent::~QKeyEvent() confuse it by pressing both \uicontrol{Shift} keys simultaneously and releasing one of them, for example. - \sa QApplication::keyboardModifiers() + \sa QGuiApplication::keyboardModifiers() */ Qt::KeyboardModifiers QKeyEvent::modifiers() const @@ -1357,7 +1357,7 @@ QResizeEvent::~QResizeEvent() signal when they are deleted. If the last top-level window is closed, the - QApplication::lastWindowClosed() signal is emitted. + QGuiApplication::lastWindowClosed() signal is emitted. The isAccepted() function returns \c true if the event's receiver has agreed to close the widget; call accept() to agree to close the @@ -1366,7 +1366,7 @@ QResizeEvent::~QResizeEvent() \sa QWidget::close(), QWidget::hide(), QObject::destroyed(), QCoreApplication::exec(), QCoreApplication::quit(), - QApplication::lastWindowClosed() + QGuiApplication::lastWindowClosed() */ /*! @@ -2676,9 +2676,8 @@ QDragEnterEvent::~QDragEnterEvent() is within its boundaries, if it accepts \l{QWidget::setAcceptDrops()}{drop events} and \l {QWidget::dragEnterEvent()}{enter events}. The widget should - examine the event to see what kind of data it - \l{QDragMoveEvent::provides()}{provides}, and call the accept() - function to accept the drop if appropriate. + examine the event to see what kind of \l{mimeData()}{data} it + provides, and call the accept() function to accept the drop if appropriate. The rectangle supplied by the answerRect() function can be used to restrict drops to certain parts of the widget. For example, we can check whether the diff --git a/src/gui/kernel/qopenglcontext.cpp b/src/gui/kernel/qopenglcontext.cpp index ab782fac34..7b111c73e1 100644 --- a/src/gui/kernel/qopenglcontext.cpp +++ b/src/gui/kernel/qopenglcontext.cpp @@ -274,7 +274,7 @@ QMutex QOpenGLContextPrivate::makeCurrentTrackerMutex; or OpenGL ES 1.x. For more information about the OpenGL API, refer to the official - \l{OpenGL documentation}. + \l{http://www.opengl.org}{OpenGL documentation}. For an example of how to use QOpenGLContext see the \l{OpenGL Window Example}{OpenGL Window} example. @@ -591,6 +591,8 @@ QOpenGLFunctions *QOpenGLContext::functions() const /*! \fn T *QOpenGLContext::versionFunctions() const + \overload versionFunctions() + Returns a pointer to an object that provides access to all functions for the version and profile of this context. Before using any of the functions they must be initialized by calling QAbstractOpenGLFunctions::initializeOpenGLFunctions(). @@ -640,8 +642,6 @@ QOpenGLFunctions *QOpenGLContext::functions() const Usually one would use the template version of this function to automatically have the result cast to the correct type. - - \sa T *QOpenGLContext::versionFunctions() */ QAbstractOpenGLFunctions *QOpenGLContext::versionFunctions(const QOpenGLVersionProfile &versionProfile) const { diff --git a/src/gui/kernel/qplatformsystemtrayicon_qpa.cpp b/src/gui/kernel/qplatformsystemtrayicon_qpa.cpp index 5d7ff7864d..c4cec40a10 100644 --- a/src/gui/kernel/qplatformsystemtrayicon_qpa.cpp +++ b/src/gui/kernel/qplatformsystemtrayicon_qpa.cpp @@ -130,7 +130,7 @@ QPlatformSystemTrayIcon::~QPlatformSystemTrayIcon() const QIcon &icon, MessageIcon iconType, int secs) Shows a balloon message for the entry with the given \a title, message \a msg and \a icon for the time specified in \a secs. \a iconType is used as a hint for the implementing platform. - \sa QSystemTrayIcon::showMessage + \sa QSystemTrayIcon::showMessage() */ /*! diff --git a/src/gui/kernel/qsurfaceformat.cpp b/src/gui/kernel/qsurfaceformat.cpp index 2f1b30ae4a..fe5615d394 100644 --- a/src/gui/kernel/qsurfaceformat.cpp +++ b/src/gui/kernel/qsurfaceformat.cpp @@ -396,7 +396,7 @@ bool QSurfaceFormat::hasAlpha() const /*! Set the preferred stencil buffer size to \a size bits. - \sa stencilBufferSize(), setStencil(), stencil() + \sa stencilBufferSize() */ void QSurfaceFormat::setStencilBufferSize(int size) { @@ -409,7 +409,7 @@ void QSurfaceFormat::setStencilBufferSize(int size) /*! Returns the stencil buffer size in bits. - \sa stencil(), setStencil(), setStencilBufferSize() + \sa setStencilBufferSize() */ int QSurfaceFormat::stencilBufferSize() const { diff --git a/src/gui/opengl/qopengltexture.cpp b/src/gui/opengl/qopengltexture.cpp index d5a7399c18..5407142b18 100644 --- a/src/gui/opengl/qopengltexture.cpp +++ b/src/gui/opengl/qopengltexture.cpp @@ -1825,7 +1825,7 @@ void QOpenGLTexture::setSize(int width, int height, int depth) /*! Returns the width of a 1D, 2D or 3D texture. - \sa height(), depth(), setDimensions() + \sa height(), depth(), setSize() */ int QOpenGLTexture::width() const { @@ -1836,7 +1836,7 @@ int QOpenGLTexture::width() const /*! Returns the height of a 2D or 3D texture. - \sa width(), depth(), setDimensions() + \sa width(), depth(), setSize() */ int QOpenGLTexture::height() const { @@ -1847,7 +1847,7 @@ int QOpenGLTexture::height() const /*! Returns the depth of a 3D texture. - \sa width(), height(), setDimensions() + \sa width(), height(), setSize() */ int QOpenGLTexture::depth() const { @@ -1913,7 +1913,7 @@ int QOpenGLTexture::mipLevels() const Returns the maximum number of mipmap levels that this texture can have given the current dimensions. - \sa setMipLevels(), mipLevels(), setDimensions() + \sa setMipLevels(), mipLevels(), setSize() */ int QOpenGLTexture::maximumMipLevels() const { @@ -2018,7 +2018,7 @@ void QOpenGLTexture::allocateStorage() The texture format, dimensions, mipmap levels and array layers cannot be altered once storage ihas been allocated. - \sa allocateStorage(), setDimensions(), setMipLevels(), setLayers(), setFormat() + \sa allocateStorage(), setSize(), setMipLevels(), setLayers(), setFormat() */ bool QOpenGLTexture::isStorageAllocated() const { @@ -2367,7 +2367,7 @@ void QOpenGLTexture::setMipLevelRange(int baseLevel, int maxLevel) /*! Returns the range of mipmap levels that can be used for texture lookups with this texture. - \sa mipBaseLevel(), mipMaxLevel(), mipLevelRange() + \sa mipBaseLevel(), mipMaxLevel() */ QPair QOpenGLTexture::mipLevelRange() const { diff --git a/src/gui/painting/qbrush.cpp b/src/gui/painting/qbrush.cpp index d8dfae1e2c..8bbe6b6f42 100644 --- a/src/gui/painting/qbrush.cpp +++ b/src/gui/painting/qbrush.cpp @@ -503,7 +503,7 @@ QBrush::QBrush(Qt::GlobalColor color, Qt::BrushStyle style) The style is set to Qt::TexturePattern. The color will only have an effect for QBitmaps. - \sa setColor(), setPixmap() + \sa setColor(), setTexture() */ QBrush::QBrush(const QColor &color, const QPixmap &pixmap) @@ -520,7 +520,7 @@ QBrush::QBrush(const QColor &color, const QPixmap &pixmap) The style is set to Qt::TexturePattern. The color will only have an effect for QBitmaps. - \sa setColor(), setPixmap() + \sa setColor(), setTexture() */ QBrush::QBrush(Qt::GlobalColor color, const QPixmap &pixmap) { diff --git a/src/gui/painting/qpaintengine_raster.cpp b/src/gui/painting/qpaintengine_raster.cpp index 4a26da104d..bdd0d9cd4c 100644 --- a/src/gui/painting/qpaintengine_raster.cpp +++ b/src/gui/painting/qpaintengine_raster.cpp @@ -308,9 +308,9 @@ QRasterPaintEnginePrivate::QRasterPaintEnginePrivate() : of painting operations in Qt for Embedded Linux. Note that this functionality is only available in - \l{Qt for Embedded Linux}. + Qt for Embedded Linux. - In \l{Qt for Embedded Linux}, painting is a pure software + In Qt for Embedded Linux, painting is a pure software implementation. But starting with Qt 4.2, it is possible to add an accelerated graphics driver to take advantage of available hardware resources. @@ -318,19 +318,15 @@ QRasterPaintEnginePrivate::QRasterPaintEnginePrivate() : Hardware acceleration is accomplished by creating a custom screen driver, accelerating the copying from memory to the screen, and implementing a custom paint engine accelerating the various - painting operations. Then a custom paint device (derived from the - QCustomRasterPaintDevice class) and a custom window surface - (derived from QWSWindowSurface) must be implemented to make - \l{Qt for Embedded Linux} aware of the accelerated driver. + painting operations. Then a custom paint device and a custom + window surface must be implemented to make + Qt for Embedded Linux aware of the accelerated driver. \note The QRasterPaintEngine class does not support 8-bit images. Instead, they need to be converted to a supported format, such as QImage::Format_ARGB32_Premultiplied. - See the \l {Adding an Accelerated Graphics Driver to Qt for Embedded Linux} - documentation for details. - - \sa QCustomRasterPaintDevice, QPaintEngine + \sa QPaintEngine */ /*! diff --git a/src/gui/text/qfontmetrics.cpp b/src/gui/text/qfontmetrics.cpp index 58c9addec1..1a66657cbd 100644 --- a/src/gui/text/qfontmetrics.cpp +++ b/src/gui/text/qfontmetrics.cpp @@ -1587,7 +1587,7 @@ QRectF QFontMetricsF::boundingRect(const QRectF &rect, int flags, const QString& \li Qt::TextWordBreak breaks the text to fit the rectangle. \endlist - These flags are defined in \l{Qt::TextFlags}. + These flags are defined in the \l{Qt::TextFlag} enum. If Qt::TextExpandTabs is set in \a flags, the following behavior is used to interpret tab characters in the text: diff --git a/src/opengl/qgl.cpp b/src/opengl/qgl.cpp index 16044df8b1..b1fbe2ac71 100644 --- a/src/opengl/qgl.cpp +++ b/src/opengl/qgl.cpp @@ -3041,7 +3041,7 @@ bool QGLContext::areSharing(const QGLContext *context1, const QGLContext *contex If this context is a valid context in an overlay plane, returns the plane's transparent color. Otherwise returns an \l{QColor::isValid()}{invalid} color. - The returned color's \l{QColor::pixel()}{pixel} value is + The returned color's \l{QColormap::pixel()}{pixel} value is the index of the transparent color in the colormap of the overlay plane. (Naturally, the color's RGB values are meaningless.) diff --git a/src/sql/models/qsqlrelationaltablemodel.cpp b/src/sql/models/qsqlrelationaltablemodel.cpp index 6aeef89483..2214e73658 100644 --- a/src/sql/models/qsqlrelationaltablemodel.cpp +++ b/src/sql/models/qsqlrelationaltablemodel.cpp @@ -671,7 +671,7 @@ void QSqlRelationalTableModel::clear() \value InnerJoin - Inner join mode, return rows when there is at least one match in both tables. \value LeftJoin - Left join mode, returns all rows from the left table (table_name1), even if there are no matches in the right table (table_name2). - \sa QSqlRelationalTableModel::setJoinMode + \sa QSqlRelationalTableModel::setJoinMode() \since 4.8 */ diff --git a/src/widgets/doc/src/widgets-and-layouts/layout.qdoc b/src/widgets/doc/src/widgets-and-layouts/layout.qdoc index f74da2fa0a..99d512b507 100644 --- a/src/widgets/doc/src/widgets-and-layouts/layout.qdoc +++ b/src/widgets/doc/src/widgets-and-layouts/layout.qdoc @@ -32,8 +32,8 @@ \brief A tour of the standard layout managers and an introduction to custom layouts. - \previouspage Widgets and Layouts - \contentspage Widgets and Layouts + \previouspage Qt Widgets + \contentspage Qt Widgets \nextpage {Styles and Style Aware Widgets}{Styles} \ingroup frameworks-technologies diff --git a/src/widgets/doc/src/widgets-tutorial.qdoc b/src/widgets/doc/src/widgets-tutorial.qdoc index 985a430cba..d4cf063231 100644 --- a/src/widgets/doc/src/widgets-tutorial.qdoc +++ b/src/widgets/doc/src/widgets-tutorial.qdoc @@ -89,7 +89,7 @@ \section1 Real world widget examples - In these \l{Widget examples} {more advanced examples}, the code + In these \l{Qt Widgets Examples} {more advanced examples}, the code that creates the widgets and layouts is stored in other files. For example, the GUI for a main window may be created in the constructor of a QMainWindow subclass. -- cgit v1.2.3