Skip to content

Commit

Permalink
Doc: Provide a DocBook version of the beginqdoc and endqdoc macros
Browse files Browse the repository at this point in the history
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.

Due to a certain bug in QDoc, when generating the DocBook format, QDoc
would expand an HTML specific macro definition when a DocBook specific
one was not provided.

As this bug is now being fixed, the DocBook format will lose some of the
output that it was previously generating.

For example, the "\beginqdoc" and "\endqdoc" macros are defined, for
HTML, to expand to the beginning of block-comment text, "/*!" and ending
of block-comment text, "*/".

To avoid losing the usage of "\beginqdoc" and "\endqdoc`" when
generating DocBook, an equivalent expansion of the macro is now provided
for the DocBook format.

Change-Id: I45fb54f1f56077771c091323a69fd63e09a910eb
Reviewed-by: Paul Wicking <[email protected]>
Reviewed-by: Topi Reiniö <[email protected]>
  • Loading branch information
diseraluca-qt committed Jun 14, 2023
1 parent fae72a8 commit 5e7106e
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions doc/global/macros.qdocconf
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,9 @@ macro.mdash.DocBook = "&#8212;"
macro.pi.HTML = "&Pi;"
macro.pi.DocBook = "&#928;"
macro.beginqdoc.HTML = "/*!"
macro.beginqdoc.DocBook = "/*!"
macro.endqdoc.HTML = "*/"
macro.endqdoc.DocBook = "*/"
macro.borderedimage = "\\div {class=\"border\"} \\image \1\n\\enddiv"
macro.examplecategory = "\\meta category {\1}\n\\ingroup category \1"

Expand Down

0 comments on commit 5e7106e

Please sign in to comment.