diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2022-06-14 12:19:25 +0200 |
|---|---|---|
| committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2022-06-15 16:06:36 +0000 |
| commit | 74352d2ed9d397d8de73e74dd1c2461589a7b843 (patch) | |
| tree | 5f39ed504aa041f33c6e6fa26c29750c593db4fb | |
| parent | 77efdbfd627e8466cad2e96b2940d47919474e5f (diff) | |
Doc: QDoc Manual: Fix documentation for \qtcmakepackage command
The \raw HTML used in the example output did not close the <table> and
<div> elements, causing the page to be misformatted. Add the closing
elements and wrap the example output in <blockquote>.
Fix the related \code snippet to have proper QDoc comment delimiters.
Fixes: QTBUG-103863
Change-Id: I13bd78f5d00e2dfe31d0f1c79f1fe0af543d76bb
Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
(cherry picked from commit 158ba8d5e2a91e0c23c770228ce2be9f6cbeb7f3)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
| -rw-r--r-- | src/qdoc/doc/qdoc-manual-markupcmds.qdoc | 27 |
1 files changed, 15 insertions, 12 deletions
diff --git a/src/qdoc/doc/qdoc-manual-markupcmds.qdoc b/src/qdoc/doc/qdoc-manual-markupcmds.qdoc index fb7660f8e..7d1abc1cb 100644 --- a/src/qdoc/doc/qdoc-manual-markupcmds.qdoc +++ b/src/qdoc/doc/qdoc-manual-markupcmds.qdoc @@ -3252,25 +3252,28 @@ and namespaces. This information will then appear in a table at the top of the class or namespace documentation page. For example: - \code - / *! - \namespace Foo - \inheaderfile Bar - \qtcmakepackage Baz - \brief A namespace. + \badcode * + /*! + \namespace Foo + \inheaderfile Bar + \qtcmakepackage Baz + \brief A namespace. - [...] - * / - \endcode + ... + \1/ + \endcode QDoc will output this as \raw HTML + <blockquote> <h1 class="title">Foo Namespace</h1> - <p>A namespace. <a href="#details">More...</a></p> + <p>A namespace. <a>More...</a></p> <div class="table"><table class="alignedsummary"> - <tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <Bar></span> - </td></tr><tr><td class="memItemLeft rightAlign topAlign"> CMake:</td><td class="memItemRight bottomAlign"> find_package(Qt6 REQUIRED COMPONENTS Baz)</td></tr> + <tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <Bar></span></td></tr> + <tr><td class="memItemLeft rightAlign topAlign"> CMake:</td><td class="memItemRight bottomAlign"> find_package(Qt6 REQUIRED COMPONENTS Baz)</td></tr> + </table></div> + </blockquote> \endraw |