diff options
| author | Paul Wicking <paul.wicking@qt.io> | 2023-08-22 10:49:24 +0200 |
|---|---|---|
| committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2023-08-22 14:33:57 +0000 |
| commit | 7f22f9de5f18a13c559c71c6a871f3cd97caf009 (patch) | |
| tree | dc9edf41cd4d06f9649ae762e19e5034f1dc4c8e | |
| parent | 6325e4d27f94bbee0dcab9f268836f24f7803a6e (diff) | |
Doc: Use sensible argument in `\printto` command
The "Scene Graph - Vulkan Under QML" example includes snippets of code
from the example source file(s) using a combination of the `\skipto` and
`\printto` QDoc commands. The former skips content until the line that
contains the argument passed to the command
(here, "class VulkanSquircle"). The latter prints lines up to, but not
including, the line that contains the argument passed to the command
(here, "public"). I suspect the author's intention was for QDoc to
output lines from the start of the class declaration until the public
access specifier in the member specification of the class. However, the
first instance of `public` QDoc encounters is the base-specifier of the
derived class, which is on the same line as the argument to the
`\skipto` command. Hence, there's nothing for QDoc to output.
Modifying the argument to include the colon that indicates the keyword
is for member-declarations ensures QDoc generates output as expected.
Fixes: QTBUG-116304
Change-Id: Ibfc17fbacd10f902fc2a5f57873fe0990571535e
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
Reviewed-by: Safiyyah Moosa <safiyyah.moosa@qt.io>
(cherry picked from commit 9e3b681460b3d61ff5bc9e35e437a849ff94e221)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
| -rw-r--r-- | examples/quick/scenegraph/vulkanunderqml/doc/src/vulkanunderqml.qdoc | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/examples/quick/scenegraph/vulkanunderqml/doc/src/vulkanunderqml.qdoc b/examples/quick/scenegraph/vulkanunderqml/doc/src/vulkanunderqml.qdoc index 102c3850df..2ab1da7fce 100644 --- a/examples/quick/scenegraph/vulkanunderqml/doc/src/vulkanunderqml.qdoc +++ b/examples/quick/scenegraph/vulkanunderqml/doc/src/vulkanunderqml.qdoc @@ -37,7 +37,7 @@ \quotefromfile scenegraph/vulkanunderqml/vulkansquircle.h \skipto class VulkanSquircle - \printto public + \printto public: We then go on to declare public and private items: |