tools/qdoc3/test/macros.qdocconf


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68

macro.aacute.HTML       = "&aacute;"
macro.Aring.HTML        = "&Aring;"
macro.aring.HTML        = "&aring;"
macro.Auml.HTML         = "&Auml;"
macro.author            = "\\bold{Author:}"
macro.br.HTML           = "<br />"
macro.BR.HTML           = "<br />"
macro.copyright.HTML    = "&copy;"
macro.eacute.HTML       = "&eacute;"
macro.gui               = "\\bold"
macro.hr.HTML           = "<hr />"
macro.iacute.HTML       = "&iacute;"
macro.key               = "\\bold"
macro.menu              = "\\bold"
macro.note              = "\\bold{Note:}"
macro.oslash.HTML       = "&oslash;"
macro.ouml.HTML         = "&ouml;"
macro.QA                = "\\e{Qt Assistant}"
macro.QD                = "\\e{Qt Designer}"
macro.QL                = "\\e{Qt Linguist}"
macro.QQV               = "\\e{Qt QML Viewer}"
macro.param             = "\\e"
macro.raisedaster.HTML  = "<sup>*</sup>"
macro.rarrow.HTML       = "&rarr;"
macro.reg.HTML          = "<sup>&reg;</sup>"
macro.return            = "Returns"
macro.starslash         = "\\c{*/}"
macro.begincomment      = "\\c{/*}"
macro.endcomment        = "\\c{*/}"
macro.uuml.HTML         = "&uuml;"
macro.mdash.HTML        = "&mdash;"

# Macros for floating images and floating images with alt text.
# Ideally, these would be HTML-only macros.

macro.floatleft = "\\raw HTML\n" \
                  "<div style=\"float: left; margin-right: 2em\">" \
                  "\\endraw\n" \
                  "\\inlineimage \1\n" \
                  "\\raw HTML\n" \
                  "</div>\n" \
                  "\\endraw\n"
macro.figureleft = "\\raw HTML\n" \
                   "<div style=\"float: left; margin-right: 2em\">" \
                   "\\endraw\n" \
                   "\\inlineimage \1 \2\n" \
                   "\\raw HTML\n" \
                   "</div>\n" \
                   "\\endraw\n"
macro.floatright = "\\raw HTML\n" \
                   "<div style=\"float: right; margin-left: 2em\">\n" \
                   "\\endraw\n" \
                   "\\inlineimage \1\n" \
                   "\\raw HTML\n" \
                   "</div>\n" \
                   "\\endraw\n"
macro.figureright = "\\raw HTML\n" \
                    "<div style=\"float: right; margin-left: 2em\">" \
                    "\\endraw\n" \
                    "\\inlineimage \1 \2\n" \
                    "\\raw HTML\n" \
                    "</div>\n" \
                    "\\endraw\n"

macro.beginfloatleft.HTML   = "<div style=\"float: left; margin-right: 2em\">"
macro.beginfloatright.HTML  = "<div style=\"float: right; margin-left: 2em\">"
macro.endfloat.HTML         = "</div>"
macro.clearfloat.HTML       = "<br style=\"clear: both\" />"