Details
-
User Story
-
Resolution: Unresolved
-
P2: Important
-
None
-
None
-
None
Description
The API for including code in documentation has been organically grown.
There are different variants for including code in-line, allowing you to also set the language (e.g. \code, \qml, \badcode). This has a direct influence on whether the code is highlighted.
In addition, there's different ways to include external code snippets : \quotefile, \quotefromfile, \snippet. But there is no way currently to set the language (and therefore the desired highlighting) of the external snippet.
The exact source of the snippet (inline, full file, part of file) should be orthogonal to the question which language the snippet is in. For external files, the language could be auto-detected by file suffix though.
Attachments
Issue Links
- is duplicated by
-
QTBUG-106915 QDoc needs a \pseudocode block type between \badcode and \code
-
- Closed
-
- relates to
-
QTBUG-98981 Consider the unification of the code commands
-
- Open
-