Doc: corrected link/autolink issues in corelib

Task-number: QTBUG-43115
Change-Id: I31da92e3a7c4dd7b75ee283dbfecd77e284978ca
Reviewed-by: Martin Smith <martin.smith@digia.com>
This commit is contained in:
Nico Vertriest 2015-01-21 15:42:19 +01:00
parent d5f55d9870
commit 1afe110b8f
20 changed files with 53 additions and 45 deletions

View File

@ -44,7 +44,7 @@
animations in parallel. The animation group finishes when the
longest lasting animation has finished.
You can treat QParallelAnimation as any other QAbstractAnimation,
You can treat QParallelAnimationGroup as any other QAbstractAnimation,
e.g., pause, resume, or add it to other animation groups.
\code

View File

@ -25,7 +25,7 @@ qhp.QtCore.subprojects.classes.sortPages = true
tagfile = ../../../doc/qtcore/qtcore.tags
depends += activeqt qtdbus qtgui qtwidgets qtnetwork qtdoc qtmacextras qtquick qtlinguist qtdesigner qtconcurrent qtxml qmake
depends += activeqt qtdbus qtgui qtwidgets qtnetwork qtdoc qtmacextras qtquick qtlinguist qtdesigner qtconcurrent qtxml qmake qtwinextras
# depends += qtqml # Qt namespace collides with QtQml::Qt, see QTBUG-38630
headerdirs += ..

View File

@ -498,7 +498,7 @@
\value TextExpandTabs Makes the U+0009 (ASCII tab) character move to
the next tab stop.
\value TextShowMnemonic Displays the string "\&P" as \underline{P}
(see QButton for an example). For an ampersand, use "\&\&".
For an ampersand, use "\&\&".
\value TextWordWrap Breaks lines at appropriate points, e.g. at word
boundaries.
\value TextWrapAnywhere Breaks lines anywhere, even within words.
@ -902,8 +902,7 @@
on QWidget::contentsRect(). This is set by the widget's author.
\value WA_LayoutUsesWidgetRect Ignore the layout item rect from the style
when laying out this widget with QLayout. This makes a difference in
QMacStyle and QPlastiqueStyle for some widgets.
when laying out this widget with QLayout.
\value WA_MacNoClickThrough When a widget that has this attribute set
is clicked, and its window is inactive, the click will make the window
@ -1162,7 +1161,7 @@
_NET_WM_WINDOW_TYPE X11 window property. See
http://standards.freedesktop.org/wm-spec/ for more details. This
attribute has no effect on non-X11 platforms. \b Note: Qt
automatically sets this attribute for QMenus added to a QMenuBar.
automatically sets this attribute for QMenu objects added to a QMenuBar.
\value WA_X11NetWmWindowTypePopupMenu Adds _NET_WM_WINDOW_TYPE_POPUP_MENU
to the window's _NET_WM_WINDOW_TYPE X11 window property. See

View File

@ -229,7 +229,7 @@ static QString qrcScheme()
}
/*!
This is a convenience version of select operating on QUrls. If the scheme is not file or qrc,
This is a convenience version of select operating on QUrl objects. If the scheme is not file or qrc,
\a filePath is returned immediately. Otherwise selection is applied to the path of \a filePath
and a QUrl is returned with the selected path and other QUrl parts the same as \a filePath.

View File

@ -708,7 +708,7 @@ bool QIODevice::reset()
number of bytes to allocate in a buffer before reading.
Subclasses that reimplement this function must call the base
implementation in order to include the size of QIODevices' buffer. Example:
implementation in order to include the size of the buffer of QIODevice. Example:
\snippet code/src_corelib_io_qiodevice.cpp 1

View File

@ -1446,7 +1446,7 @@ void QProcess::setStandardErrorFile(const QString &fileName, OpenMode mode)
The following shell command:
\snippet code/src_corelib_io_qprocess.cpp 2
Can be accomplished with QProcesses with the following code:
Can be accomplished with QProcess with the following code:
\snippet code/src_corelib_io_qprocess.cpp 3
*/
void QProcess::setStandardOutputProcess(QProcess *destination)

View File

@ -197,7 +197,7 @@ Q_GLOBAL_STATIC(QStringList, resourceSearchPaths)
path requested in setFileName().
The unregisterResource() function removes a reference to a particular
file. If there are QResources that currently reference resources related
file. If there are QResource objects that currently reference resources related
to the unregistered file, they will continue to be valid but the resource
file itself will be removed from the resource roots, and thus no further
QResource can be created pointing into this resource data. The resource

View File

@ -77,15 +77,10 @@ QT_BEGIN_NAMESPACE
this user, but should still be assumed to be unreachable by applications by
other users.
The only exception is QStandardPaths::TempLocation (which is the same as
QDir::tempPath()): the path returned may be application-specific, but files
stored there may be accessed by other applications run by the same user.
Data interchange with other users is out of the scope of QStandardPaths.
\value DesktopLocation Returns the user's desktop directory. This is a generic value.
On systems with no concept of a desktop, this is the same as
QStandardPaths::HomeLocation.
On systems with no concept of a desktop.
\value DocumentsLocation Returns the directory containing user document files.
This is a generic value. The returned path is never empty.
\value FontsLocation Returns the directory containing user's fonts. This is a generic value.
@ -118,9 +113,6 @@ QT_BEGIN_NAMESPACE
\value GenericCacheLocation Returns a directory location where user-specific non-essential
(cached) data, shared across applications, should be written. This is a generic value.
Note that the returned path may be empty if the system has no concept of shared cache.
\value GenericDataLocation Returns a directory location where persistent
data shared across applications can be stored. This is a generic value. The returned
path is never empty.
\value RuntimeLocation Returns a directory location where runtime communication
files should be written, like Unix local sockets. This is a generic value.
The returned path may be empty on some systems.

View File

@ -82,7 +82,7 @@
For the convenience of generating encoded URL strings or query
strings, there are two static functions called
fromPercentEncoding() and toPercentEncoding() which deal with
percent encoding and decoding of QStrings.
percent encoding and decoding of QString objects.
Calling isRelative() will tell whether or not the URL is
relative. A relative URL can be resolved by passing it as argument
@ -172,7 +172,7 @@
setters setting components of a URL; it is not permitted in
the QUrl constructor, in fromEncoded() or in setUrl().
For more information on this mode, see the documentation for
QUrl::FullyDecoded.
\l {QUrl::ComponentFormattingOption}{QUrl::FullyDecoded}.
In TolerantMode, the parser has the following behaviour:
@ -4055,7 +4055,7 @@ QString QUrl::errorString() const
/*!
\since 5.1
Converts a list of \a urls into a list of QStrings, using toString(\a options).
Converts a list of \a urls into a list of QString objects, using toString(\a options).
*/
QStringList QUrl::toStringList(const QList<QUrl> &urls, FormattingOptions options)
{

View File

@ -414,7 +414,7 @@ bool QUrlQuery::operator ==(const QUrlQuery &other) const
}
/*!
Returns \c true if this QUrlQUery object contains no key-value pairs, such as
Returns \c true if this QUrlQuery object contains no key-value pairs, such as
after being default-constructed or after parsing an empty query string.
\sa setQuery(), clear()

View File

@ -531,8 +531,8 @@ bool QJsonArray::contains(const QJsonValue &value) const
\a i must be a valid index position in the array (i.e., \c{0 <= i <
size()}).
The return value is of type QJsonValueRef, a helper class for QJsonArray
and QJsonObject. When you get an object of type QJsonValueRef, you can
The return value is of type \keyword QJsonValueRef, a helper class for QJsonArray
and QJsonObject. When you get an object of type \keyword QJsonValueRef, you can
use it as if it were a reference to a QJsonValue. If you assign to it,
the assignment will apply to the character in the QJsonArray of QJsonObject
from which you got the reference.
@ -731,13 +731,14 @@ bool QJsonArray::operator!=(const QJsonArray &other) const
/*! \fn QJsonValueRef QJsonArray::iterator::operator*() const
Returns a modifiable reference to the current item.
You can change the value of an item by using operator*() on the
left side of an assignment.
The return value is of type QJsonValueRef, a helper class for QJsonArray
and QJsonObject. When you get an object of type QJsonValueRef, you can
The return value is of type \keyword QJsonValueRef, a helper class for QJsonArray
and QJsonObject. When you get an object of type \keyword QJsonValueRef, you can
use it as if it were a reference to a QJsonValue. If you assign to it,
the assignment will apply to the character in the QJsonArray of QJsonObject
from which you got the reference.
@ -756,8 +757,8 @@ bool QJsonArray::operator!=(const QJsonArray &other) const
This function is provided to make QJsonArray iterators behave like C++
pointers.
The return value is of type QJsonValueRef, a helper class for QJsonArray
and QJsonObject. When you get an object of type QJsonValueRef, you can
The return value is of type \keyword QJsonValueRef, a helper class for QJsonArray
and QJsonObject. When you get an object of type \keyword QJsonValueRef, you can
use it as if it were a reference to a QJsonValue. If you assign to it,
the assignment will apply to the character in the QJsonArray of QJsonObject
from which you got the reference.

View File

@ -74,6 +74,20 @@ QT_BEGIN_NAMESPACE
conversions. This implies that converting to a type that is not stored in the value will return a default
constructed return value.
\section1 QJsonValueRef
QJsonValueRef is a helper class for QJsonArray and QJsonObject.
When you get an object of type QJsonValueRef, you can
use it as if it were a reference to a QJsonValue. If you assign to it,
the assignment will apply to the element in the QJsonArray or QJsonObject
from which you got the reference.
The following methods return QJsonValueRef:
\list
\li \l {QJsonArray}::operator[](int i)
\li \l {QJsonObject}::operator[](const QString & key) const
\endlist
\sa {JSON Support in Qt}, {JSON Save Game Example}
*/
@ -416,13 +430,13 @@ QJsonValue QJsonValue::fromVariant(const QVariant &variant)
The QJsonValue types will be converted as follows:
\value Null {QVariant::}{QVariant()}
\value Null \l {QVariant::}{QVariant()}
\value Bool QMetaType::Bool
\value Double QMetaType::Double
\value String QString
\value Array QVariantList
\value Object QVariantMap
\value Undefined {QVariant::}{QVariant()}
\value Undefined \l {QVariant::}{QVariant()}
\sa fromVariant()
*/

View File

@ -386,7 +386,7 @@ void QAbstractEventDispatcher::closingDown()
\note The filter function set here receives native messages,
that is, MSG or XEvent structs.
For maximum portability, you should always try to use QEvents
For maximum portability, you should always try to use QEvent objects
and QObject::installEventFilter() whenever possible.
\sa QObject::installEventFilter()

View File

@ -2399,7 +2399,7 @@ Q_GLOBAL_STATIC_WITH_ARGS(QMutex, libraryPathMutex, (QMutex::Recursive))
INSTALL/plugins, where \c INSTALL is the directory where Qt was
installed). The directory of the application executable (NOT the
working directory) is always added, as well as the colon separated
entries of the QT_PLUGIN_PATH environment variable.
entries of the \c QT_PLUGIN_PATH environment variable.
If you want to iterate over the list, you can use the \l foreach
pseudo-keyword:
@ -2544,7 +2544,7 @@ void QCoreApplication::removeLibraryPath(const QString &path)
\note Native event filters will be disabled when the application the
Qt::AA_MacPluginApplication attribute is set.
For maximum portability, you should always try to use QEvents
For maximum portability, you should always try to use QEvent
and QObject::installEventFilter() whenever possible.
\sa QObject::installEventFilter()

View File

@ -58,7 +58,7 @@ QT_BEGIN_NAMESPACE
send events using QCoreApplication::sendEvent() and
QCoreApplication::postEvent() (spontaneous() returns \c false).
QObjects receive events by having their QObject::event() function
\l {QObject}{QObjects} receive events by having their QObject::event() function
called. The function can be reimplemented in subclasses to
customize event handling and add additional event types;
QWidget::event() is a notable example. By default, events are
@ -102,13 +102,13 @@ QT_BEGIN_NAMESPACE
\value ChildAdded An object gets a child (QChildEvent).
\value ChildPolished A widget child gets polished (QChildEvent).
\value ChildRemoved An object loses a child (QChildEvent).
\value Clipboard The clipboard contents have changed (QClipboardEvent).
\value Clipboard The clipboard contents have changed.
\value Close Widget was closed (QCloseEvent).
\value CloseSoftwareInputPanel A widget wants to close the software input panel (SIP).
\value ContentsRectChange The margins of the widget's content rect changed.
\value ContextMenu Context popup menu (QContextMenuEvent).
\value CursorChange The widget's cursor has changed.
\value DeferredDelete The object will be deleted after it has cleaned up (QDeferredDeleteEvent).
\value DeferredDelete The object will be deleted after it has cleaned up (QDeferredDeleteEvent)
\value DragEnter The cursor enters a widget during a drag and drop operation (QDragEnterEvent).
\value DragLeave The cursor leaves a widget during a drag and drop operation (QDragLeaveEvent).
\value DragMove A drag and drop operation is in progress (QDragMoveEvent).
@ -116,7 +116,7 @@ QT_BEGIN_NAMESPACE
\value DynamicPropertyChange A dynamic property was added, changed, or removed from the object.
\value EnabledChange Widget's enabled state has changed.
\value Enter Mouse enters widget's boundaries (QEnterEvent).
\value EnterEditFocus An editor widget gains focus for editing. QT_KEYPAD_NAVIGATION must be defined.
\value EnterEditFocus An editor widget gains focus for editing. \c QT_KEYPAD_NAVIGATION must be defined.
\value EnterWhatsThisMode Send to toplevel widgets when the application enters "What's This?" mode.
\value Expose Sent to a window when its on-screen contents are invalidated and need to be flushed from the backing store.
\value FileOpen File open request (QFileOpenEvent).
@ -177,7 +177,7 @@ QT_BEGIN_NAMESPACE
\value MouseTrackingChange The mouse tracking state has changed.
\value Move Widget's position changed (QMoveEvent).
\value NativeGesture The system has detected a gesture (QNativeGestureEvent).
\value OrientationChange The screens orientation has changes (QScreenOrientationChangeEvent)
\value OrientationChange The screens orientation has changes (QScreenOrientationChangeEvent).
\value Paint Screen update necessary (QPaintEvent).
\value PaletteChange Palette of the widget changed.
\value ParentAboutToChange The widget parent is about to change.

View File

@ -188,6 +188,8 @@ struct DefinedTypesFilter {
\enum QMetaType::Type
These are the built-in types supported by QMetaType:
Read doc on QChar
Read doc on \l QChar
\value Void \c void
\value Bool \c bool

View File

@ -55,7 +55,7 @@
\li When using QPointer on a QWidget (or a subclass of QWidget), previously
the QPointer would be cleared by the QWidget destructor. Now, the QPointer
is cleared by the QObject destructor (since this is when QWeakPointers are
is cleared by the QObject destructor (since this is when QWeakPointer objects are
cleared). Any QPointers tracking a widget will \b NOT be cleared before the
QWidget destructor destroys the children for the widget being tracked.

View File

@ -91,7 +91,7 @@ QT_BEGIN_NAMESPACE
its work. This is the traditional way of implementing heavy work
in GUI applications, but as multithreading is nowadays becoming available on
more and more platforms, we expect that zero-millisecond
QTimers will gradually be replaced by \l{QThread}s.
QTimer objects will gradually be replaced by \l{QThread}s.
\section1 Accuracy and Timer Resolution

View File

@ -1274,13 +1274,13 @@ QVariant::QVariant(const char *val)
/*!
\fn QVariant::QVariant(const QMap<QString, QVariant> &val)
Constructs a new variant with a map of QVariants, \a val.
Constructs a new variant with a map of \l {QVariant}s, \a val.
*/
/*!
\fn QVariant::QVariant(const QHash<QString, QVariant> &val)
Constructs a new variant with a hash of QVariants, \a val.
Constructs a new variant with a hash of \l {QVariant}s, \a val.
*/
/*!
@ -3333,7 +3333,7 @@ QDebug operator<<(QDebug dbg, const QVariant::Type p)
Q_OBJECT macro.
If the QVariant contains a sequential container and \c{T} is QVariantList, the
elements of the container will be converted into QVariants and returned as a QVariantList.
elements of the container will be converted into \l {QVariant}s and returned as a QVariantList.
\snippet code/src_corelib_kernel_qvariant.cpp 9

View File

@ -420,7 +420,7 @@ void Q_CORE_EXPORT qRegisterStaticPluginFunction(QStaticPlugin plugin)
/*!
Returns a list of static plugin instances (root components) held
by the plugin loader.
\sa staticPlugins()
\sa staticPlugin()
*/
QObjectList QPluginLoader::staticInstances()
{