qt5base-lts/doc/global
Luca Di Sera eb92d52dc7 Doc: Correct the expansion of the raisedaster macro for DocBook
QDoc allows code-expanding macros to be defined so that the user can
abstract away common code in a simple to use command.

Furthermore, macros allows for a different expansion based on the
currently generated format so that format-specific requirements can be
satisfied when required.

When format specific expansions are provided, QDoc considers the
resulting text as if it should be generated verbatim.

The "\raisedaster" macro is used to generate an superscript asterisk.

The macro is provided for both HTML and DocBook.
As the macro has format-specific expansions, the expanded code will be
read verbatim.
Nonetheless, while the HTML expansion expands to actual HTML, the
DocBook expansion expands to an equivalent QDoc code, which will not be
generated correctly.

To avoid the issue, the DocBook version of "\raisedaster" is modified so
that it produces the correct DocBook code.

Change-Id: I3a37838bda885af42f8d93b86ec08126d7146ff9
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2023-06-14 16:18:55 +02:00
..
externalsites Doc: Change links from froglogic to qt domain 2022-12-09 11:40:49 +01:00
includes Doc: explicitly mention C++ when discussing linking to C++ libraries 2023-01-31 09:46:49 +00:00
includes-online Use SPDX license identifiers 2022-05-16 16:37:38 +02:00
snippets/code Move the docs for porting to QRegularExpression to a common place 2022-07-20 13:15:59 +02:00
template Doc: Add CSS styling and icon for 'technical preview' items 2023-05-10 04:40:38 +00:00
compat.qdocconf Doc: Ignore QML/JavaScript parsing errors 2017-02-07 08:34:39 +00:00
config.qdocconf Doc: Stop writing host-specific paths to generated .index files 2023-06-14 14:18:55 +00:00
externalsites.qdocconf Doc: Do not include the external sites by default 2014-09-03 09:40:59 +02:00
fileextensions.qdocconf qdoc: Add *.webp as an default image suffix 2023-02-21 18:56:07 +00:00
html-config.qdocconf Adapt qdoc macros and documentation for DocBook 2022-11-04 18:39:03 +01:00
html-footer-online.qdocconf Doc: Update copyright year in the template 2023-02-07 18:04:11 +00:00
html-footer.qdocconf Doc: Update copyright year in the template 2023-02-07 18:04:11 +00:00
html-header-offline.qdocconf Doc: Add CSS styling and icon for 'technical preview' items 2023-05-10 04:40:38 +00:00
html-header-online.qdocconf Doc: Add CSS styling and icon for 'technical preview' items 2023-05-10 04:40:38 +00:00
htmltabs.qdocconf Doc: Fix syntax in \tab macro example 2022-05-09 19:12:14 +02:00
macros-online.qdocconf Doc: Add DocBook version of youtube macro 2023-06-14 16:18:55 +02:00
macros.qdocconf Doc: Correct the expansion of the raisedaster macro for DocBook 2023-06-14 16:18:55 +02:00
manifest-meta.qdocconf Remove the "classwizard" example 2023-05-16 18:33:18 +02:00
qt-cpp-defines.qdocconf Clean up qt-cpp-defines.qdocconf 2022-07-20 13:15:56 +02:00
qt-html-templates-offline-simple.qdocconf Fix typos in docs and comments 2022-06-15 21:31:02 +02:00
qt-html-templates-offline.qdocconf Doc: Add a dark offline CSS 2022-11-11 18:48:50 +02: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: Fix online macros for commercial template 2022-06-21 22:08:34 +00:00
qt-module-defaults-online.qdocconf Doc: Update copyright year in the template 2023-02-07 18:04:11 +00:00
qt-module-defaults.qdocconf doc/global: Remove references to Qt 5 in comments 2020-11-19 17:27:30 +01:00