diff options
| author | Topi Reinio <topi.reinio@digia.com> | 2015-09-24 13:59:48 +0200 |
|---|---|---|
| committer | Topi Reiniö <topi.reinio@digia.com> | 2015-09-24 12:21:35 +0000 |
| commit | e87df57abfdd2df821bfed54a5dc3f2380b36486 (patch) | |
| tree | 2dffedd821f329d597794fac4fc8393e31c37dd2 /src/tools/qdoc/doc | |
| parent | 17650467302819e1fd333f0682445d50fc52eb68 (diff) | |
qdoc: Document macro parameters
QDoc has the ability to accept parameters for macros but it was
never documented.
Change-Id: Iaf9a629c906fbe1552717c7444a0fd52b5655a3f
Reviewed-by: Martin Smith <martin.smith@digia.com>
Diffstat (limited to 'src/tools/qdoc/doc')
| -rw-r--r-- | src/tools/qdoc/doc/qdoc-manual-qdocconf.qdoc | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/src/tools/qdoc/doc/qdoc-manual-qdocconf.qdoc b/src/tools/qdoc/doc/qdoc-manual-qdocconf.qdoc index 01a0e7f578..d490f8549a 100644 --- a/src/tools/qdoc/doc/qdoc-manual-qdocconf.qdoc +++ b/src/tools/qdoc/doc/qdoc-manual-qdocconf.qdoc @@ -734,6 +734,18 @@ command to render a superscript asterisk, but only when generating HTML. + A macro can also take up to seven parameters: + + \badcode + macro.hello = "Hello \1!" + \endcode + + Parameters are passed to macros the same way as to other commands: + + \badcode + \hello World + \endcode + See also \l {alias-variable} {alias}. \target manifestmeta-variable |