diff options
| author | Jeremy Henty <onepoint@starurchin.org> | 2015-04-04 02:32:27 +0100 |
|---|---|---|
| committer | Jeremy Henty <onepoint@starurchin.org> | 2015-04-04 02:32:27 +0100 |
| commit | b782494ca659398200902feebb0495a168584a68 (patch) | |
| tree | d4a644c7c56ccaaf0f5c67c8b5675578d9a7f1cf /doc | |
| parent | d31441e084328f99afddaf0bb263949e6716144d (diff) | |
Escape '#' characters.
The '#' character has a special meaning for doxygen; it is a reference
to a documented entity so it must be escaped when the character itself
is wanted. The doxygen command "\#" writes a '#' to the output.
This fixes many doxygen warnings of the form "warning: explicit link
request to 'foo' could not be resolved".
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/dw-out-of-flow-floats.doc | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/doc/dw-out-of-flow-floats.doc b/doc/dw-out-of-flow-floats.doc index bc371222..53c6b220 100644 --- a/doc/dw-out-of-flow-floats.doc +++ b/doc/dw-out-of-flow-floats.doc @@ -34,7 +34,7 @@ more complicated in a case like this: <head> <style> - #fl-1, #fl-2, #fl-3 { float: right } + \#fl-1, \#fl-2, \#fl-3 { float: right } </style> </head> <body> @@ -49,22 +49,22 @@ more complicated in a case like this: The floats are generated in this order: -- #fl-1 (generated by #bl-1), -- #fl-2 (generated by #bl-2), -- #fl-3 (generated by #bl-1). +- \#fl-1 (generated by \#bl-1), +- \#fl-2 (generated by \#bl-2), +- \#fl-3 (generated by \#bl-1). Since the floats must be moved into the CB list in this order, it becomes clear that the floats from one GB list cannot be moved at once. For this reason, each float is assigned a "mark", which is different from the last one as soon as the generator is *before* the generator of the float added before. In the example above, there are -three generators: body, #bl-1, and #bl-2 (in this order), and floats +three generators: body, \#bl-1, and \#bl-2 (in this order), and floats are assigned these marks: -- #fl-1: 0, -- #fl-2: also 0, -- #fl-3 is assigned 1, since its generator (#bl-1) lies before the - last generator (#bl-2). +- \#fl-1: 0, +- \#fl-2: also 0, +- \#fl-3 is assigned 1, since its generator (\#bl-1) lies before the + last generator (\#bl-2). dw::OutOfFlowMgr::moveFromGBToCB will then iterate over all marks, so that the generation order is preserved. |