diff options
| author | Topi Reinio <topi.reinio@digia.com> | 2015-08-28 15:01:17 +0200 |
|---|---|---|
| committer | Topi Reiniö <topi.reinio@digia.com> | 2015-09-07 11:11:43 +0000 |
| commit | 9c6a49078ae0da65f605384ba16e2a46e19ff5a1 (patch) | |
| tree | 58bc58114c2085846a95efb214c6e95eeb22f408 /src/tools/qdoc/doc/qdoc-manual-qdocconf.qdoc | |
| parent | 72e5fda3bd1b50ee3e0da0b5ef6505e632f7f5bc (diff) | |
qdoc: Introduce codeprefix & codesuffix, re-introduce codeindent
In order to provide acceptable results for styling the documentation
for rendering using QTextBrowser (instead of a full browser engine),
QDoc needs flexibility in adjusting the generated HTML.
This commit introduces and documents codeprefix and codesuffix
variables for qdocconf, and re-introduces the once-removed
support for codeindent.
The default codeindent value is reset to 0. These changes have no
effect to the generated output unless the above variables are
defined.
Change-Id: I6eb40dc0700725622e5a525ef19b5626b3b2b6a5
Reviewed-by: Martin Smith <martin.smith@digia.com>
Diffstat (limited to 'src/tools/qdoc/doc/qdoc-manual-qdocconf.qdoc')
| -rw-r--r-- | src/tools/qdoc/doc/qdoc-manual-qdocconf.qdoc | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/src/tools/qdoc/doc/qdoc-manual-qdocconf.qdoc b/src/tools/qdoc/doc/qdoc-manual-qdocconf.qdoc index 2472b0f4fb..01a0e7f578 100644 --- a/src/tools/qdoc/doc/qdoc-manual-qdocconf.qdoc +++ b/src/tools/qdoc/doc/qdoc-manual-qdocconf.qdoc @@ -185,6 +185,13 @@ to adjust the appearance of certain types of HTML elements, this level of indentation is not always required. + \target codeprefix-variable + \target codesuffix-variable + \section1 codeprefix, codesuffix + + The \c codeprefix and \c codesuffix variables specify a pair of + strings that each code snippet is enclosed in. + \target defines-variable \section1 defines |