Update of /cvsroot/boost/boost/tools/quickbook/doc
In directory sc8-pr-cvs3.sourceforge.net:/tmp/cvs-serv10876/doc
Modified Files:
quickbook.qbk
Log Message:
callouts refinement
Index: quickbook.qbk
===================================================================
RCS file: /cvsroot/boost/boost/tools/quickbook/doc/quickbook.qbk,v
retrieving revision 1.65
retrieving revision 1.66
diff -u -d -r1.65 -r1.66
--- quickbook.qbk 27 Feb 2007 15:22:16 -0000 1.65
+++ quickbook.qbk 28 Feb 2007 10:20:50 -0000 1.66
@@ -85,7 +85,7 @@
[:[EMAIL PROTECTED]/quickbook.qbk quickbook.qbk]]
-Originally named QuickDoc, this funky tool that never dies evolved into a
+Originally named QuickDoc, this funky tool that never dies, evolved into a
funkier tool thanks to Eric Niebler who resurrected the project making it
generate __boostbook__ instead of HTML. The __boostbook__ documentation format
is an extension of __docbook__, an SGML or XML based format for describing
@@ -1671,7 +1671,52 @@
[foo_bar]
-Checkout [EMAIL PROTECTED]/../test/stub.cpp stub.cpp] to see the actual code.
+This is the actual code:
+
+ //[ foo_bar
+ std::string foo_bar() /*< The /Mythical/ FooBar.
+ See [EMAIL PROTECTED]://en.wikipedia.org/wiki/Foobar
Foobar for details] >*/
+ {
+ return "foo-bar"; /*< return 'em, foo-bar man! >*/
+ }
+ //]
+
+The callouts bugs are placed exactly where the special callout comment
+is situated. It can be anywhere in the code. The bugs can be rather
+obtrusive, however. They get in the way of the clarity of the code.
+Another special callout comment style is available:
+
+ /*<< some [*quickbook] markup here >>*/
+
+This is the line-oriented version of the callout. With this, the "bug"
+is placed at the very left of the code block, away from the actual code.
+By placing it at the far left, the code is rendered un-obscured.
+Example:
+
+[class_]
+
+Here's the code for that:
+
+ //[ class_
+ class x
+ {
+ public:
+
+ /*<< Constructor >>*/
+ x() : n(0)
+ {
+ }
+ /*<< Destructor >>*/
+ ~x()
+ {
+ }
+
+ private:
+
+ /*<< `n` member variable >>*/
+ int n;
+ };
+ //]
[endsect]
-------------------------------------------------------------------------
Take Surveys. Earn Cash. Influence the Future of IT
Join SourceForge.net's Techsay panel and you'll get the chance to share your
opinions on IT & business topics through brief surveys-and earn cash
http://www.techsay.com/default.php?page=join.php&p=sourceforge&CID=DEVDEV
_______________________________________________
Boost-cvs mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/boost-cvs
