Fix some doc errors.

Change-Id: Ib874d7e9671d9cee75fe41f4dac5d0de7b09245e
Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
This commit is contained in:
Frederik Gladhorn 2013-09-17 17:50:28 +02:00 committed by The Qt Project
parent 5957f245c6
commit b751fcf32a
21 changed files with 28 additions and 31 deletions

View File

@ -384,7 +384,7 @@ QDebugStateSaver::QDebugStateSaver(QDebug &dbg)
/*! /*!
Destroyes a QDebugStateSaver instance, which restores the settings 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() \sa QDebug::setAutoInsertSpaces(), QDebug::autoInsertSpaces()
*/ */

View File

@ -2203,7 +2203,7 @@ QString QCoreApplication::organizationDomain()
If not set, the application name defaults to the executable name (since 5.0). 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() \fn void QCoreApplication::applicationNameChanged()

View File

@ -354,7 +354,7 @@ struct DefinedTypesFilter {
This function is typically used together with construct() This function is typically used together with construct()
to perform low-level management of the memory used by a type. 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. 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 QMetaType instance was created for. If \a copy is null, creates
a default constructed instance. 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 Destroys the \a data, assuming it is of the type that this
QMetaType instance was created for. QMetaType instance was created for.
\sa QMetaType::create(const void *) \sa QMetaType::create()
*/ */
/*! /*!

View File

@ -83,7 +83,7 @@ QT_BEGIN_NAMESPACE
A typical application of semaphores is for controlling access to A typical application of semaphores is for controlling access to
a circular buffer shared by a producer thread and a consumer 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. to use QSemaphore to solve that problem.
A non-computing example of a semaphore would be dining at a A non-computing example of a semaphore would be dining at a

View File

@ -75,7 +75,7 @@
simultaneously are unpredictable. simultaneously are unpredictable.
Wait conditions are a powerful thread synchronization primitive. 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 to use QWaitCondition as an alternative to QSemaphore for
controlling access to a circular buffer shared by a producer controlling access to a circular buffer shared by a producer
thread and a consumer thread. thread and a consumer thread.

View File

@ -506,6 +506,7 @@ QT_BEGIN_NAMESPACE
\value CarriageReturn \value CarriageReturn
\value Space \value Space
\value Nbsp Non-breaking space. \value Nbsp Non-breaking space.
\value SoftHyphen
\value ReplacementCharacter The character shown when a font has no glyph \value ReplacementCharacter The character shown when a font has no glyph
for a certain codepoint. A special question mark character is often for a certain codepoint. A special question mark character is often
used. Codecs use this codepoint when input data cannot be used. Codecs use this codepoint when input data cannot be

View File

@ -290,7 +290,7 @@
\value BezierSpline Allows defining a custom easing curve using a cubic bezier spline \value BezierSpline Allows defining a custom easing curve using a cubic bezier spline
\sa addCubicBezierSegment() \sa addCubicBezierSegment()
\value TCBSpline Allows defining a custom easing curve using a TCB spline \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 \value Custom This is returned if the user specified a custom curve type with
setCustomType(). Note that you cannot call setType() with this value, setCustomType(). Note that you cannot call setType() with this value,
but type() can return it. but type() can return it.

View File

@ -285,7 +285,7 @@ int qFindString(const QChar *haystack, int haystackLen, int from,
\row \li \b{\\W} \row \li \b{\\W}
\li Matches a non-word character. \li Matches a non-word character.
\row \li \b{\\\e{n}} \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 \endtable
\b{Note:} The C++ compiler transforms backslashes in strings. \b{Note:} The C++ compiler transforms backslashes in strings.

View File

@ -70,7 +70,7 @@ QT_END_NAMESPACE
This function needs to handle all messages to the path of the This function needs to handle all messages to the path of the
virtual object, when the SubPath option is specified. 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). 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 \fn QString QDBusVirtualObject::introspect(const QString &path) const
This function needs to handle the introspection of the 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 \code
<interface name="org.qtproject.QtDBus.MyObject" > <interface name="org.qtproject.QtDBus.MyObject" >

View File

@ -50,8 +50,8 @@ QT_BEGIN_NAMESPACE
/*! /*!
\class QAccessiblePlugin \class QAccessiblePlugin
\brief The QAccessiblePlugin class provides an abstract base for \brief The QAccessiblePlugin class provides an abstract base class
accessibility plugins. for plugins provinding accessibility information for user interface elements.
\ingroup plugins \ingroup plugins
\ingroup accessibility \ingroup accessibility
@ -60,7 +60,7 @@ QT_BEGIN_NAMESPACE
base class, reimplementing the pure virtual function create(), base class, reimplementing the pure virtual function create(),
and exporting the class with the Q_PLUGIN_METADATA() macro. and exporting the class with the Q_PLUGIN_METADATA() macro.
\sa QAccessibleBridgePlugin, {How to Create Qt Plugins} \sa {How to Create Qt Plugins}
*/ */
/*! /*!

View File

@ -1412,7 +1412,7 @@ qreal QImage::devicePixelRatio() const
Sets the the device pixel ratio for the image. This is the Sets the the device pixel ratio for the image. This is the
ratio between image pixels and device-independent pixels. 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: two effects:
QPainters that are opened on the image will be scaled. For QPainters that are opened on the image will be scaled. For

View File

@ -48,7 +48,7 @@
with QImageReader. with QImageReader.
This class is used to show simple animations without sound. If you want 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. multimedia framework instead.
First, create a QMovie object by passing either the name of a file or a First, create a QMovie object by passing either the name of a file or a

View File

@ -1742,7 +1742,7 @@ QByteArray QPictureIO::pictureFormat(const QString &fileName)
Make sure that \a d is at the right position in the device (for Make sure that \a d is at the right position in the device (for
example, at the beginning of the file). example, at the beginning of the file).
\sa QIODevice::at() \sa QIODevice::pos()
*/ */
QByteArray QPictureIO::pictureFormat(QIODevice *d) QByteArray QPictureIO::pictureFormat(QIODevice *d)

View File

@ -660,7 +660,7 @@ qreal QPixmap::devicePixelRatio() const
Sets the the device pixel ratio for the pixmap. This is the Sets the the device pixel ratio for the pixmap. This is the
ratio between image pixels and device-independent pixels. 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: two effects:
QPainters that are opened on the pixmap will be scaled. For QPainters that are opened on the pixmap will be scaled. For

View File

@ -888,8 +888,6 @@ bool QKeySequence::isEmpty() const
in English. At the time of writing, Microsoft and Open Group do in English. At the time of writing, Microsoft and Open Group do
not appear to have issued equivalent recommendations for other not appear to have issued equivalent recommendations for other
languages. languages.
\sa qt_set_sequence_auto_mnemonic()
*/ */
QKeySequence QKeySequence::mnemonic(const QString &text) QKeySequence QKeySequence::mnemonic(const QString &text)
{ {

View File

@ -84,7 +84,7 @@ public:
QBackingStore might be used by an application that wants to use QPainter QBackingStore might be used by an application that wants to use QPainter
without OpenGL acceleration and without the extra overhead of using the without OpenGL acceleration and without the extra overhead of using the
QWidget or QGraphicsView UI stacks. For an example of how to use 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}.
*/ */
/*! /*!

View File

@ -162,7 +162,7 @@ QPagedPaintDevice::~QPagedPaintDevice()
/*! /*!
Sets the size of the a page to \a size. Sets the size of the a page to \a size.
\sa setPageSizeMM \sa setPageSizeMM()
*/ */
void QPagedPaintDevice::setPageSize(PageSize size) 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 The margins are purely a hint to the drawing method. They don't affect the
coordinate system or clipping. coordinate system or clipping.
\sa margins \sa margins()
*/ */
void QPagedPaintDevice::setMargins(const Margins &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. returns the current margins of the paint device. The default is 0.
\sa setMargins \sa setMargins()
*/ */
QPagedPaintDevice::Margins QPagedPaintDevice::margins() const QPagedPaintDevice::Margins QPagedPaintDevice::margins() const
{ {

View File

@ -2437,7 +2437,7 @@ QWizardPage *QWizard::currentPage() const
By default, this property has a value of -1, indicating that no page is By default, this property has a value of -1, indicating that no page is
currently shown. currently shown.
\sa currentIdChanged(), currentPage() \sa currentPage()
*/ */
int QWizard::currentId() const int QWizard::currentId() const
{ {

View File

@ -239,8 +239,6 @@
\brief the number of screens currently available on the system. \brief the number of screens currently available on the system.
\since 4.6 \since 4.6
\sa screenCountChanged()
*/ */
/*! /*!

View File

@ -5519,7 +5519,7 @@ void QWidget::unsetLocale()
On some desktop platforms (including Windows and Unix), the application name On some desktop platforms (including Windows and Unix), the application name
(from QGuiApplication::applicationDisplayName) is added at the end of the (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 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 \sa windowIcon, windowIconText, windowModified, windowFilePath
*/ */

View File

@ -109,7 +109,7 @@ void QProxyStylePrivate::ensureBaseStyle() const
/*! /*!
Constructs a QProxyStyle object for overriding behavior in the 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. {application style} if base \a style is not specified.
Ownership of \a style is transferred to QProxyStyle. Ownership of \a style is transferred to QProxyStyle.
@ -128,7 +128,7 @@ QProxyStyle::QProxyStyle(QStyle *style) :
/*! /*!
Constructs a QProxyStyle object for overriding behavior in Constructs a QProxyStyle object for overriding behavior in
the base style specified by style \a key, or in the current 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. style \a key is unrecognized.
\sa QStyleFactory::create() \sa QStyleFactory::create()