From b751fcf32ac9dd1aa31a4df4993593f8ead88d81 Mon Sep 17 00:00:00 2001 From: Frederik Gladhorn Date: Tue, 17 Sep 2013 17:50:28 +0200 Subject: Fix some doc errors. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Change-Id: Ib874d7e9671d9cee75fe41f4dac5d0de7b09245e Reviewed-by: Thiago Macieira Reviewed-by: Topi Reiniö Reviewed-by: Jerome Pasion --- src/corelib/io/qdebug.cpp | 2 +- src/corelib/kernel/qcoreapplication.cpp | 2 +- src/corelib/kernel/qmetatype.cpp | 8 ++++---- src/corelib/thread/qsemaphore.cpp | 2 +- src/corelib/thread/qwaitcondition.qdoc | 2 +- src/corelib/tools/qchar.cpp | 1 + src/corelib/tools/qeasingcurve.cpp | 2 +- src/corelib/tools/qregexp.cpp | 2 +- src/dbus/qdbusvirtualobject.cpp | 4 ++-- src/gui/accessible/qaccessibleplugin.cpp | 6 +++--- src/gui/image/qimage.cpp | 2 +- src/gui/image/qmovie.cpp | 2 +- src/gui/image/qpicture.cpp | 2 +- src/gui/image/qpixmap.cpp | 2 +- src/gui/kernel/qkeysequence.cpp | 2 -- src/gui/painting/qbackingstore.cpp | 2 +- src/gui/painting/qpagedpaintdevice.cpp | 6 +++--- src/widgets/dialogs/qwizard.cpp | 2 +- src/widgets/kernel/qdesktopwidget.qdoc | 2 -- src/widgets/kernel/qwidget.cpp | 2 +- src/widgets/styles/qproxystyle.cpp | 4 ++-- 21 files changed, 28 insertions(+), 31 deletions(-) diff --git a/src/corelib/io/qdebug.cpp b/src/corelib/io/qdebug.cpp index 9cb5609dac..b8cd0f70b2 100644 --- a/src/corelib/io/qdebug.cpp +++ b/src/corelib/io/qdebug.cpp @@ -384,7 +384,7 @@ QDebugStateSaver::QDebugStateSaver(QDebug &dbg) /*! Destroyes a QDebugStateSaver instance, which restores the settings - used by \a dbg when the QDebugStateSaver instance was created. + used when the QDebugStateSaver instance was created. \sa QDebug::setAutoInsertSpaces(), QDebug::autoInsertSpaces() */ diff --git a/src/corelib/kernel/qcoreapplication.cpp b/src/corelib/kernel/qcoreapplication.cpp index 1ccf5f2197..f3caa1d918 100644 --- a/src/corelib/kernel/qcoreapplication.cpp +++ b/src/corelib/kernel/qcoreapplication.cpp @@ -2203,7 +2203,7 @@ QString QCoreApplication::organizationDomain() If not set, the application name defaults to the executable name (since 5.0). - \sa organizationName, organizationDomain, applicationVersion, applicationFilePath + \sa organizationName, organizationDomain, applicationVersion, applicationFilePath() */ /*! \fn void QCoreApplication::applicationNameChanged() diff --git a/src/corelib/kernel/qmetatype.cpp b/src/corelib/kernel/qmetatype.cpp index 70c2e236dd..a9ba4aaaad 100644 --- a/src/corelib/kernel/qmetatype.cpp +++ b/src/corelib/kernel/qmetatype.cpp @@ -354,7 +354,7 @@ struct DefinedTypesFilter { This function is typically used together with construct() to perform low-level management of the memory used by a type. - \sa QMetaType::construct(void *where, const void *copy), QMetaType::sizeOf(int) + \sa QMetaType::construct(), QMetaType::sizeOf() */ /*! @@ -363,7 +363,7 @@ struct DefinedTypesFilter { Returns flags of the type for which this QMetaType instance was constructed. - \sa QMetaType::TypeFlags, QMetaType::typeFlags(int type) + \sa QMetaType::TypeFlags, QMetaType::typeFlags() */ /*! @@ -380,7 +380,7 @@ struct DefinedTypesFilter { QMetaType instance was created for. If \a copy is null, creates a default constructed instance. - \sa QMetaType::destroy(void*) + \sa QMetaType::destroy() */ /*! @@ -390,7 +390,7 @@ struct DefinedTypesFilter { Destroys the \a data, assuming it is of the type that this QMetaType instance was created for. - \sa QMetaType::create(const void *) + \sa QMetaType::create() */ /*! diff --git a/src/corelib/thread/qsemaphore.cpp b/src/corelib/thread/qsemaphore.cpp index 1cf893f42c..90e4f2a20a 100644 --- a/src/corelib/thread/qsemaphore.cpp +++ b/src/corelib/thread/qsemaphore.cpp @@ -83,7 +83,7 @@ QT_BEGIN_NAMESPACE A typical application of semaphores is for controlling access to a circular buffer shared by a producer thread and a consumer - thread. The \l{threads/semaphores}{Semaphores} example shows how + thread. The \l{Semaphores Example} shows how to use QSemaphore to solve that problem. A non-computing example of a semaphore would be dining at a diff --git a/src/corelib/thread/qwaitcondition.qdoc b/src/corelib/thread/qwaitcondition.qdoc index 9aa633a210..b1a396d504 100644 --- a/src/corelib/thread/qwaitcondition.qdoc +++ b/src/corelib/thread/qwaitcondition.qdoc @@ -75,7 +75,7 @@ simultaneously are unpredictable. Wait conditions are a powerful thread synchronization primitive. - The \l{threads/waitconditions}{Wait Conditions} example shows how + The \l{Wait Conditions Example} example shows how to use QWaitCondition as an alternative to QSemaphore for controlling access to a circular buffer shared by a producer thread and a consumer thread. diff --git a/src/corelib/tools/qchar.cpp b/src/corelib/tools/qchar.cpp index 5de06d8c4a..ff17a52a75 100644 --- a/src/corelib/tools/qchar.cpp +++ b/src/corelib/tools/qchar.cpp @@ -506,6 +506,7 @@ QT_BEGIN_NAMESPACE \value CarriageReturn \value Space \value Nbsp Non-breaking space. + \value SoftHyphen \value ReplacementCharacter The character shown when a font has no glyph for a certain codepoint. A special question mark character is often used. Codecs use this codepoint when input data cannot be diff --git a/src/corelib/tools/qeasingcurve.cpp b/src/corelib/tools/qeasingcurve.cpp index 67e0711796..23451f095c 100644 --- a/src/corelib/tools/qeasingcurve.cpp +++ b/src/corelib/tools/qeasingcurve.cpp @@ -290,7 +290,7 @@ \value BezierSpline Allows defining a custom easing curve using a cubic bezier spline \sa addCubicBezierSegment() \value TCBSpline Allows defining a custom easing curve using a TCB spline - \sa addTCBSegment + \sa addTCBSegment() \value Custom This is returned if the user specified a custom curve type with setCustomType(). Note that you cannot call setType() with this value, but type() can return it. diff --git a/src/corelib/tools/qregexp.cpp b/src/corelib/tools/qregexp.cpp index 086cdeb108..c0cd419c53 100644 --- a/src/corelib/tools/qregexp.cpp +++ b/src/corelib/tools/qregexp.cpp @@ -285,7 +285,7 @@ int qFindString(const QChar *haystack, int haystackLen, int from, \row \li \b{\\W} \li Matches a non-word character. \row \li \b{\\\e{n}} - \li The \e{n}-th \l backreference, e.g. \\1, \\2, etc. + \li The \e{n}-th backreference, e.g. \\1, \\2, etc. \endtable \b{Note:} The C++ compiler transforms backslashes in strings. diff --git a/src/dbus/qdbusvirtualobject.cpp b/src/dbus/qdbusvirtualobject.cpp index d6d4f01a33..15e01c2f20 100644 --- a/src/dbus/qdbusvirtualobject.cpp +++ b/src/dbus/qdbusvirtualobject.cpp @@ -70,7 +70,7 @@ QT_END_NAMESPACE This function needs to handle all messages to the path of the virtual object, when the SubPath option is specified. - The service, path, interface and methos are all part of the message. + The service, path, interface and methos are all part of the \a message. Must return true when the message is handled, otherwise false (will generate dbus error message). */ @@ -79,7 +79,7 @@ QT_END_NAMESPACE \fn QString QDBusVirtualObject::introspect(const QString &path) const This function needs to handle the introspection of the - virtual object. It must return xml of the form: + virtual object on \a path. It must return xml of the form: \code diff --git a/src/gui/accessible/qaccessibleplugin.cpp b/src/gui/accessible/qaccessibleplugin.cpp index c509d6be72..8cdbca6767 100644 --- a/src/gui/accessible/qaccessibleplugin.cpp +++ b/src/gui/accessible/qaccessibleplugin.cpp @@ -50,8 +50,8 @@ QT_BEGIN_NAMESPACE /*! \class QAccessiblePlugin - \brief The QAccessiblePlugin class provides an abstract base for - accessibility plugins. + \brief The QAccessiblePlugin class provides an abstract base class + for plugins provinding accessibility information for user interface elements. \ingroup plugins \ingroup accessibility @@ -60,7 +60,7 @@ QT_BEGIN_NAMESPACE base class, reimplementing the pure virtual function create(), and exporting the class with the Q_PLUGIN_METADATA() macro. - \sa QAccessibleBridgePlugin, {How to Create Qt Plugins} + \sa {How to Create Qt Plugins} */ /*! diff --git a/src/gui/image/qimage.cpp b/src/gui/image/qimage.cpp index 8e5f6391a7..3d6315a7fe 100644 --- a/src/gui/image/qimage.cpp +++ b/src/gui/image/qimage.cpp @@ -1412,7 +1412,7 @@ qreal QImage::devicePixelRatio() const Sets the the device pixel ratio for the image. This is the ratio between image pixels and device-independent pixels. - The default value is 1.0. Setting it to something else has + The default \a scaleFactor is 1.0. Setting it to something else has two effects: QPainters that are opened on the image will be scaled. For diff --git a/src/gui/image/qmovie.cpp b/src/gui/image/qmovie.cpp index ae526f5ba7..26e35c6db6 100644 --- a/src/gui/image/qmovie.cpp +++ b/src/gui/image/qmovie.cpp @@ -48,7 +48,7 @@ with QImageReader. This class is used to show simple animations without sound. If you want - to display video and media content, use the \l{Phonon Module}{Phonon} + to display video and media content, use the \l{Qt Multimedia} multimedia framework instead. First, create a QMovie object by passing either the name of a file or a diff --git a/src/gui/image/qpicture.cpp b/src/gui/image/qpicture.cpp index e7fbb2a6a9..be7a1e8001 100644 --- a/src/gui/image/qpicture.cpp +++ b/src/gui/image/qpicture.cpp @@ -1742,7 +1742,7 @@ QByteArray QPictureIO::pictureFormat(const QString &fileName) Make sure that \a d is at the right position in the device (for example, at the beginning of the file). - \sa QIODevice::at() + \sa QIODevice::pos() */ QByteArray QPictureIO::pictureFormat(QIODevice *d) diff --git a/src/gui/image/qpixmap.cpp b/src/gui/image/qpixmap.cpp index 04f0da1a83..f98ca04f4d 100644 --- a/src/gui/image/qpixmap.cpp +++ b/src/gui/image/qpixmap.cpp @@ -660,7 +660,7 @@ qreal QPixmap::devicePixelRatio() const Sets the the device pixel ratio for the pixmap. This is the ratio between image pixels and device-independent pixels. - The default value is 1.0. Setting it to something else has + The default \a scaleFactor is 1.0. Setting it to something else has two effects: QPainters that are opened on the pixmap will be scaled. For diff --git a/src/gui/kernel/qkeysequence.cpp b/src/gui/kernel/qkeysequence.cpp index c577831208..a2db939ace 100644 --- a/src/gui/kernel/qkeysequence.cpp +++ b/src/gui/kernel/qkeysequence.cpp @@ -888,8 +888,6 @@ bool QKeySequence::isEmpty() const in English. At the time of writing, Microsoft and Open Group do not appear to have issued equivalent recommendations for other languages. - - \sa qt_set_sequence_auto_mnemonic() */ QKeySequence QKeySequence::mnemonic(const QString &text) { diff --git a/src/gui/painting/qbackingstore.cpp b/src/gui/painting/qbackingstore.cpp index c1f7c6c738..3a36762502 100644 --- a/src/gui/painting/qbackingstore.cpp +++ b/src/gui/painting/qbackingstore.cpp @@ -84,7 +84,7 @@ public: QBackingStore might be used by an application that wants to use QPainter without OpenGL acceleration and without the extra overhead of using the QWidget or QGraphicsView UI stacks. For an example of how to use - QBackingStore see the \l{gui/rasterwindow}{Raster Window} example. + QBackingStore see the \l{Raster Window Example}. */ /*! diff --git a/src/gui/painting/qpagedpaintdevice.cpp b/src/gui/painting/qpagedpaintdevice.cpp index 0387f0020f..f41d1830fd 100644 --- a/src/gui/painting/qpagedpaintdevice.cpp +++ b/src/gui/painting/qpagedpaintdevice.cpp @@ -162,7 +162,7 @@ QPagedPaintDevice::~QPagedPaintDevice() /*! Sets the size of the a page to \a size. - \sa setPageSizeMM + \sa setPageSizeMM() */ void QPagedPaintDevice::setPageSize(PageSize size) { @@ -205,7 +205,7 @@ QSizeF QPagedPaintDevice::pageSizeMM() const The margins are purely a hint to the drawing method. They don't affect the coordinate system or clipping. - \sa margins + \sa margins() */ void QPagedPaintDevice::setMargins(const Margins &margins) { @@ -215,7 +215,7 @@ void QPagedPaintDevice::setMargins(const Margins &margins) /*! returns the current margins of the paint device. The default is 0. - \sa setMargins + \sa setMargins() */ QPagedPaintDevice::Margins QPagedPaintDevice::margins() const { diff --git a/src/widgets/dialogs/qwizard.cpp b/src/widgets/dialogs/qwizard.cpp index 3f214809b4..dba3e8a97d 100644 --- a/src/widgets/dialogs/qwizard.cpp +++ b/src/widgets/dialogs/qwizard.cpp @@ -2437,7 +2437,7 @@ QWizardPage *QWizard::currentPage() const By default, this property has a value of -1, indicating that no page is currently shown. - \sa currentIdChanged(), currentPage() + \sa currentPage() */ int QWizard::currentId() const { diff --git a/src/widgets/kernel/qdesktopwidget.qdoc b/src/widgets/kernel/qdesktopwidget.qdoc index 789a812afb..e8bda3c805 100644 --- a/src/widgets/kernel/qdesktopwidget.qdoc +++ b/src/widgets/kernel/qdesktopwidget.qdoc @@ -239,8 +239,6 @@ \brief the number of screens currently available on the system. \since 4.6 - - \sa screenCountChanged() */ /*! diff --git a/src/widgets/kernel/qwidget.cpp b/src/widgets/kernel/qwidget.cpp index 76c4cbcb97..02d95d2fa5 100644 --- a/src/widgets/kernel/qwidget.cpp +++ b/src/widgets/kernel/qwidget.cpp @@ -5519,7 +5519,7 @@ void QWidget::unsetLocale() On some desktop platforms (including Windows and Unix), the application name (from QGuiApplication::applicationDisplayName) is added at the end of the window title, if set. This is done by the QPA plugin, so it is shown to the - user, but isn't part of the \l windowTitle string. + user, but isn't part of the windowTitle string. \sa windowIcon, windowIconText, windowModified, windowFilePath */ diff --git a/src/widgets/styles/qproxystyle.cpp b/src/widgets/styles/qproxystyle.cpp index b63e820bb9..eeed1a532b 100644 --- a/src/widgets/styles/qproxystyle.cpp +++ b/src/widgets/styles/qproxystyle.cpp @@ -109,7 +109,7 @@ void QProxyStylePrivate::ensureBaseStyle() const /*! Constructs a QProxyStyle object for overriding behavior in the - specified base \a style, or in the current \l{QApplication::style} + specified base \a style, or in the current \l{QApplication::style()} {application style} if base \a style is not specified. Ownership of \a style is transferred to QProxyStyle. @@ -128,7 +128,7 @@ QProxyStyle::QProxyStyle(QStyle *style) : /*! Constructs a QProxyStyle object for overriding behavior in the base style specified by style \a key, or in the current - \l{QApplication::style}{application style} if the specified + \l{QApplication::style()}{application style} if the specified style \a key is unrecognized. \sa QStyleFactory::create() -- cgit v1.2.3