Doc: Move selected \keywords to be \targets instead

QDoc now handles \keyword slightly differently - it no longer
generates a unique html anchor at the location it appears in.
Instead, it'll inherit the anchor of the documentation item
it appears in.

Therefore, switch the \keyword commands that are used for
linking to a subsection within a page to be \targets instead,
so they'll get an anchor and not link to the top of the page.

Change-Id: Iec6d3f0edbcfb0aec95e222615eca9de2b0e153e
Reviewed-by: Martin Smith <martin.smith@digia.com>
This commit is contained in:
Topi Reinio 2015-09-07 10:25:46 +02:00 committed by Topi Reiniö
parent 8a79e4d678
commit a5cc210dec
8 changed files with 23 additions and 23 deletions

View File

@ -169,8 +169,8 @@
convenience, the containers are forward declared in \c
<QtContainerFwd>.
\keyword assignable data type
\keyword assignable data types
\target assignable data type
\target assignable data types
The values stored in the various containers can be of any
\e{assignable data type}. To qualify, a type must provide a
@ -220,7 +220,7 @@
\codeline
\snippet streaming/main.cpp 2
\keyword default-constructed value
\target default-constructed value
The documentation of certain container class functions refer to
\e{default-constructed values}; for example, QVector
@ -546,7 +546,7 @@
The above example only shows a problem with QVector, but
the problem exists for all the implicitly shared Qt containers.
\keyword foreach
\target foreach
\section1 The foreach Keyword
If you just want to iterate over all the items in a container
@ -655,11 +655,11 @@
To describe algorithmic complexity, we use the following
terminology, based on the "big Oh" notation:
\keyword constant time
\keyword logarithmic time
\keyword linear time
\keyword linear-logarithmic time
\keyword quadratic time
\target constant time
\target logarithmic time
\target linear time
\target linear-logarithmic time
\target quadratic time
\list
\li \b{Constant time:} O(1). A function is said to run in constant

View File

@ -71,8 +71,8 @@
data. The shared data is deleted when the reference count becomes
zero.
\keyword deep copy
\keyword shallow copy
\target deep copy
\target shallow copy
When dealing with shared objects, there are two ways of copying an
object. We usually speak about \e deep and \e shallow copies. A deep
@ -142,6 +142,6 @@
(QMap, QVector, etc.) while you use
\l{STL-style iterators}{STL-style iterator}. See \l{Implicit sharing iterator problem}.
\keyword implicitly shared classes
\target implicitly shared classes
\annotatedlist shared
*/

View File

@ -121,7 +121,7 @@ static const int QTEXTSTREAM_BUFFERSIZE = 16384;
digits of the generated number. Some extra number formatting
options are also available through setNumberFlags().
\keyword QTextStream manipulators
\target QTextStream manipulators
Like \c <iostream> in the standard C++ library, QTextStream also
defines several global manipulator functions:

View File

@ -533,8 +533,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 \keyword QJsonValueRef, a helper class for QJsonArray
and QJsonObject. When you get an object of type \keyword QJsonValueRef, you can
The return value is of type QJsonValueRef, 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 character in the QJsonArray of QJsonObject
from which you got the reference.
@ -739,8 +739,8 @@ bool QJsonArray::operator!=(const QJsonArray &other) const
You can change the value of an item by using operator*() on the
left side of an assignment.
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
The return value is of type QJsonValueRef, 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 character in the QJsonArray of QJsonObject
from which you got the reference.
@ -759,8 +759,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 \keyword QJsonValueRef, a helper class for QJsonArray
and QJsonObject. When you get an object of type \keyword QJsonValueRef, you can
The return value is of type QJsonValueRef, 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 character in the QJsonArray of QJsonObject
from which you got the reference.

View File

@ -492,7 +492,7 @@ int qFindString(const QChar *haystack, int haystackLen, int from,
when it is followed by 'char'.
\endtable
\keyword QRegExp wildcard matching
\target QRegExp wildcard matching
\section1 Wildcard Matching
Most command shells such as \e bash or \e cmd.exe support "file

View File

@ -2301,7 +2301,7 @@
{fetchMore()} must be reimplemented as their default implementation returns
false and does nothing.
\keyword Model/View Classes
\target Model/View Classes
\section1 The Model/View Classes
These classes use the model/view design pattern in which the

View File

@ -197,7 +197,7 @@
\section2 Stretch Factors
\keyword stretch factor
\target stretch factor
Widgets are normally created without any stretch factor set. When they are
laid out in a layout the widgets are given a share of space in accordance

View File

@ -78,7 +78,7 @@
design ideas. Creating designs visually and reading the code generated by
\l{uic} is a great way to learn Qt!
\keyword window geometry
\target window geometry
\section1 Window Geometry
QWidget provides several functions that deal with a widget's