summaryrefslogtreecommitdiffstats
path: root/src/tools/qdoc/doc/qdoc-manual-markupcmds.qdoc
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@digia.com>2015-07-30 12:51:22 +0200
committerTopi Reiniƶ <topi.reinio@digia.com>2015-08-03 12:37:57 +0000
commit7b77ef6b0a28886296e8a551339eb2874470bfc2 (patch)
treeaa3198a7a442f9f6ca34ac0e615ec15f3c8c459c /src/tools/qdoc/doc/qdoc-manual-markupcmds.qdoc
parent789c9954c788b6129b3b406db4d68b5bb52386b8 (diff)
qdoc: Make \target and \keyword commands link as expected
When resolving targets added for each node, QDoc didn't run the check recursively; this meant that \target and \keyword commands did not link when used in documentation nodes that are not direct children of the root node. There include e.g. documentation for functions and QML properties/methods. This commit fixes that issue, and also modifies the behavior of \keyword slightly: Using a \keyword no longer generates a HTML anchor reference. Instead, linking to a keyword links directly to the parent item which defines the \keyword. This produces cleaner HTML by omitting unnecessary anchors. Change-Id: I87659642770a5372409ecb09cb576fbad295155e Task-number: QTBUG-47286 Reviewed-by: Martin Smith <martin.smith@digia.com>
Diffstat (limited to 'src/tools/qdoc/doc/qdoc-manual-markupcmds.qdoc')
-rw-r--r--src/tools/qdoc/doc/qdoc-manual-markupcmds.qdoc7
1 files changed, 5 insertions, 2 deletions
diff --git a/src/tools/qdoc/doc/qdoc-manual-markupcmds.qdoc b/src/tools/qdoc/doc/qdoc-manual-markupcmds.qdoc
index b4ed391301..0f9ca463bb 100644
--- a/src/tools/qdoc/doc/qdoc-manual-markupcmds.qdoc
+++ b/src/tools/qdoc/doc/qdoc-manual-markupcmds.qdoc
@@ -2092,8 +2092,11 @@
{sa-command} {\\sa (see also)} commands.
The \\keyword command is like the \l {target-command} {\\target}
- command, but stronger. A keyword can be linked from anywhere using
- a simple syntax.
+ command, except when linking to keyword the link goes to the top of
+ the QDoc comment where the \\keyword appears in. If you want to
+ create a link target to a \c section unit within a \\page, use
+ \\target instead. A keyword can be linked from anywhere using a
+ simple syntax.
Keywords must be unique over all the documents processed during
the QDoc run. The command uses the rest of the line as its