From eb92d52dc7190efefae0fae89c7c6eb9e16cdd9d Mon Sep 17 00:00:00 2001 From: Luca Di Sera Date: Wed, 24 May 2023 16:37:34 +0200 Subject: [PATCH] Doc: Correct the expansion of the raisedaster macro for DocBook MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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ö Reviewed-by: Paul Wicking --- doc/global/macros.qdocconf | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/global/macros.qdocconf b/doc/global/macros.qdocconf index 01dbd49ab27..529682c5143 100644 --- a/doc/global/macros.qdocconf +++ b/doc/global/macros.qdocconf @@ -36,7 +36,7 @@ macro.QtVersion = "$QT_VERSION" macro.QtVer = "$QT_VER" macro.param = "\\e" macro.raisedaster.HTML = "*" -macro.raisedaster.DocBook = "\\sup{*}" +macro.raisedaster.DocBook = "*" macro.rarrow.HTML = "→" macro.rarrow.DocBook = "→" macro.reg.HTML = "®"