qt5base-lts/doc/global
Andreas Eliasson 354e4e867a 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>
2022-02-28 12:39:55 +01:00
..
externalsites Doc: Update cmake documentation link 2022-02-09 16:53:27 +01:00
includes Doc: Add \include snippets with optional parameters 2022-02-28 12:39:55 +01:00
includes-online Unify license header usage. 2016-03-29 10:20:03 +00:00
template Doc: Add styling for note/warning/important admonitions 2021-11-03 16:47:18 +02:00
compat.qdocconf Doc: Ignore QML/JavaScript parsing errors 2017-02-07 08:34:39 +00:00
config.qdocconf Update copyright year to 2022 2022-01-04 12:44:19 +01:00
externalsites.qdocconf
fileextensions.qdocconf Add shader files to examples documentation file list 2015-09-22 21:40:13 +00:00
html-config.qdocconf
html-footer-online.qdocconf Update copyright year to 2022 2022-01-04 12:44:19 +01:00
html-footer.qdocconf Update copyright year to 2022 2022-01-04 12:44:19 +01:00
html-header-offline.qdocconf
html-header-online.qdocconf doc: Update online navigation header to match http://doc.qt.io/ 2018-10-17 16:16:28 +00:00
macros-online.qdocconf Doc: Make \youtube macro work with litehtml help backend 2020-12-01 08:12:09 +00:00
macros.qdocconf wasm: move user configurable settings 2022-02-23 12:04:37 +10:00
manifest-meta.qdocconf Doc: Add thumbnail for Widgets Gallery Example 2020-11-30 17:16:22 +01:00
qt-cpp-defines.qdocconf qglobal: add a way to selectively export in Qt 6 XOR Qt 7 2022-02-09 10:49:37 -08:00
qt-html-templates-offline-simple.qdocconf Doc: Adjust offline style for the litehtml rendering engine 2020-03-26 15:28:31 +01:00
qt-html-templates-offline.qdocconf Merge remote-tracking branch 'origin/5.12' into 5.13 2019-05-09 13:06:11 +00:00
qt-html-templates-online.qdocconf Merge remote-tracking branch 'origin/5.12' into 5.13 2019-05-09 13:06:11 +00:00
qt-module-defaults-offline.qdocconf doc/global: Remove references to Qt 5 in comments 2020-11-19 17:27:30 +01:00
qt-module-defaults-online-commercial.qdocconf Doc: Update global documentation config for Qt 6 2020-06-08 13:41:07 +02:00
qt-module-defaults-online.qdocconf Update copyright year to 2022 2022-01-04 12:44:19 +01:00
qt-module-defaults.qdocconf doc/global: Remove references to Qt 5 in comments 2020-11-19 17:27:30 +01:00