summaryrefslogtreecommitdiffstats
path: root/tools/qdoc3/doc/qdoc-manual.qdoc
diff options
context:
space:
mode:
authorMartin Smith <martin.smith@nokia.com>2011-04-07 09:47:40 (GMT)
committerMartin Smith <martin.smith@nokia.com>2011-04-07 09:47:40 (GMT)
commit58e28ff518ee983f6af0e8937bbd355a2587c4d3 (patch)
tree2dca814cb2e4ed6a6a5ba35bac37a33142146387 /tools/qdoc3/doc/qdoc-manual.qdoc
parent078f18b3de857978ad42ccbcbdc5e40dd8d0159f (diff)
downloadQt-58e28ff518ee983f6af0e8937bbd355a2587c4d3.zip
Qt-58e28ff518ee983f6af0e8937bbd355a2587c4d3.tar.gz
Qt-58e28ff518ee983f6af0e8937bbd355a2587c4d3.tar.bz2
qdoc: Updated the QDoc manual.
Diffstat (limited to 'tools/qdoc3/doc/qdoc-manual.qdoc')
-rw-r--r--tools/qdoc3/doc/qdoc-manual.qdoc23
1 files changed, 13 insertions, 10 deletions
diff --git a/tools/qdoc3/doc/qdoc-manual.qdoc b/tools/qdoc3/doc/qdoc-manual.qdoc
index 31c56a1..9039296 100644
--- a/tools/qdoc3/doc/qdoc-manual.qdoc
+++ b/tools/qdoc3/doc/qdoc-manual.qdoc
@@ -7560,23 +7560,26 @@
\target macro-variable
\section1 macro
- The \c macro variable can be used to create your own QDoc
- commands.
-
- The general syntax is \tt {macro.\e{command} =
- "\e{definition}}". The definition can be described using QDoc
- syntax. In addition it is possible to provide an HTML definition
- by appending .HTML to the variable.
+ The \c macro variable is used to create your own simple QDoc
+ commands or to redefine existing QDoc commands. The syntax is \tt
+ {macro.\e{command} = \e{definition}}, where the definition is
+ written using QDoc syntax.
- For example in \l qt.qdocconf:
+ A macro command can be restricted for use in one type of output
+ generation. By appending \c {.HTML} to the macro name, for
+ example, the macro is only used when generating HTML output. By
+ appending \c {.DITAXML} to the macro name, the macro is only used
+ when generating DITA XML.
\code
macro.gui = "\\bold"
macro.raisedaster.HTML = "<sup>*</sup>"
\endcode
- makes sure that the \\gui command renders its argument using a
- bold font, and that \\raisedaster renders a '*'.
+ The first macro defines the \\gui command to render its argument
+ using a bold font. The second macro defines the \\raisedaster
+ command to render a superscript asterisk, but only when generating
+ HTML.
\target naturallanguage-variable
\section1 naturallanguage