|
Boost-Commit : |
Subject: [Boost-commit] svn:boost r76254 - trunk/tools/quickbook/doc
From: dnljms_at_[hidden]
Date: 2012-01-01 07:37:01
Author: danieljames
Date: 2012-01-01 07:37:00 EST (Sun, 01 Jan 2012)
New Revision: 76254
URL: http://svn.boost.org/trac/boost/changeset/76254
Log:
Quickbook: Fix escaping in some code examples.
Text files modified:
trunk/tools/quickbook/doc/block.qbk | 24 ++++++++++++------------
1 files changed, 12 insertions(+), 12 deletions(-)
Modified: trunk/tools/quickbook/doc/block.qbk
==============================================================================
--- trunk/tools/quickbook/doc/block.qbk (original)
+++ trunk/tools/quickbook/doc/block.qbk 2012-01-01 07:37:00 EST (Sun, 01 Jan 2012)
@@ -428,19 +428,19 @@
[tip It's a good idea to use macro identifiers that are distinguishable.
For instance, in this document, macro identifiers have two leading and
-trailing underscores (e.g. `__spirit__`). The reason is to avoid
+trailing underscores (e.g. [^\__spirit__]). The reason is to avoid
unwanted macro replacement.]
Links (URLS) and images are good candidates for macros. *1*) They tend to
change a lot. It is a good idea to place all links and images in one place near the top
to make it easy to make changes. *2*) The syntax is not pretty. It's easier to read and
-write, e.g. `__spirit__` than `[@http://spirit.sourceforge.net Spirit]`.
+write, e.g. [^\__spirit__] than `[@http://spirit.sourceforge.net Spirit]`.
Some more examples:
```
-[def :-) [$theme/smiley.png]]
-[def __spirit__ [@http://spirit.sourceforge.net Spirit]]
+[def ``\:-)`` [$theme/smiley.png]]
+[def ``\__spirit__`` [@http://spirit.sourceforge.net Spirit]]
```
(See __images__ and __links__)
@@ -448,7 +448,7 @@
Invoking these macros:
```
-Hi __spirit__ :-)
+Hi ``\__spirit__`` ``\:-)``
```
will generate this:
@@ -462,10 +462,10 @@
Quickbook has some predefined macros that you can already use.
[table Predefined Macros
- [[Macro] [Meaning] [Example]]
- [[[^'''__DATE__''']] [Today's date] [__DATE__]]
- [[[^'''__TIME__''']] [The current time] [__TIME__]]
- [[[^'''__FILENAME__''']][Quickbook source filename] [__FILENAME__]]
+ [[Macro] [Meaning] [Example]]
+ [[[^\__DATE__]] [Today's date] [__DATE__]]
+ [[[^\__TIME__]] [The current time] [__TIME__]]
+ [[[^\__FILENAME__]][Quickbook source filename] [__FILENAME__]]
]
[endsect] [/Predefined Macros]
@@ -753,7 +753,7 @@
[section Blurbs]
```
-[blurb :-) [*An eye catching advertisement or note...]
+[blurb ``\:-)`` [*An eye catching advertisement or note...]
__spirit__ is an object-oriented recursive-descent parser generator framework
implemented using template meta-programming techniques. Expression templates
@@ -870,7 +870,7 @@
[[Comment] [Code]]
[
[My first program]
- [``
+ [``\`\`\ ``
#include <iostream>
int main()
@@ -878,7 +878,7 @@
std::cout << "Hello, World!" << std::endl;
return 0;
}
- ``]
+ ``\`\`\ ``]
]
]
```
Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk