diff options
| author | Luca Di Sera <luca.disera@qt.io> | 2021-08-28 09:27:57 +0200 |
|---|---|---|
| committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2021-08-30 06:55:04 +0000 |
| commit | 24aed8f15069f4f88284fe51e4487116241b9c4f (patch) | |
| tree | b6bd4df1f81e91d514002664116b30c6bed93bbe | |
| parent | 62dd63191a0d92fdb6dc6b107108015610cf98cb (diff) | |
Doc: Remove mentions of the scoping of \target / \l pairs
The documentation for the `\target` command states that a target "can be
linked *from the same document* [...]".
This statement is followed by an example that implies that
the linking must be done "from within the same QDoc comment".
Other than those assertions being contradictory, they are both
erroneous, as a target is supposed to be able to be linked to from any
other file in the same project and even from files in other projects,
given the correct configuration.
To avoid misleading the reader, both mentions of a required scoping for
a target-link pair were removed.
Additionally, a minor typo was resolved in `qdoc-guide.qdoc`.
Change-Id: Id5e84d0baf86f2b32b9cfea33aea82790ed82ab8
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
(cherry picked from commit 1cbe28aae8d744b725ad8d53887d8fb9b94a0be8)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
| -rw-r--r-- | src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc | 2 | ||||
| -rw-r--r-- | src/qdoc/doc/qdoc-manual-markupcmds.qdoc | 6 |
2 files changed, 4 insertions, 4 deletions
diff --git a/src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc b/src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc index fa3365fce..372813b16 100644 --- a/src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc +++ b/src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc @@ -209,7 +209,7 @@ \section2 QDoc Index Files Documentation projects can link to targets in other projects by specifying - a set of dependencies, or a set of direct paths to to index file(s) this + a set of dependencies, or a set of direct paths to index file(s) this project depends on. When QDoc generates documentation for a project, it will also generate an \c .index file containing URLs to each linkable entity in the project. Other projects can then define a dependency to the diff --git a/src/qdoc/doc/qdoc-manual-markupcmds.qdoc b/src/qdoc/doc/qdoc-manual-markupcmds.qdoc index 04ba1462d..9db87dadc 100644 --- a/src/qdoc/doc/qdoc-manual-markupcmds.qdoc +++ b/src/qdoc/doc/qdoc-manual-markupcmds.qdoc @@ -2035,11 +2035,11 @@ * / \endcode - The target name \e{capturing parentheses} can be linked from - within the same document containing the target in the following way: + The target name \e{capturing parentheses} can be linked to + in the following way: \list - \li \c {\l {capturing parentheses}} (from within the same QDoc comment) + \li \c {\l {capturing parentheses}} \endlist \note The brackets in the link example are required because the |