diff options
author | Andreas Eliasson <andreas.eliasson@qt.io> | 2022-02-17 13:09:54 +0100 |
---|---|---|
committer | Andreas Eliasson <andreas.eliasson@qt.io> | 2022-02-28 12:39:55 +0100 |
commit | 354e4e867acaa93e661769b2a78c146e181ba47f (patch) | |
tree | 2ffc95b5706ae01a12142160f6c60c97c6cfed1b /util/cmake | |
parent | 95603e09c9b7e552239044c4ce7d79ec1bc7467d (diff) |
Doc: Add \include snippets with optional parameters
There are many different wordings for how to use the module across the
module landing pages. The goal here is to provide consistent wording
and code formatting, which can be used across all landing pages.
The style and wording is based on what has been implemented in the
Qt CoAP module landing page.
This is the syntax in a qdoc file:
\include {module-use.qdoc} {<snippet-id>} {<argument1>}
Inside qdocinc, you can then get the value of the argument1 using the
parameter \1.
Task-number: QTBUG-100369
Change-Id: Ib25e509e119008157e69db629eb011e5a9074022
Pick-to: 6.3
Reviewed-by: Kai Koehne <kai.koehne@qt.io>
Diffstat (limited to 'util/cmake')
0 files changed, 0 insertions, 0 deletions