[Boost-commit] svn:boost r69897 - trunk/libs/geometry/doc

Subject: [Boost-commit] svn:boost r69897 - trunk/libs/geometry/doc
From: barend.gehrels_at_[hidden]
Date: 2011-03-12 12:07:18

Author: barendgehrels
Date: 2011-03-12 12:07:13 EST (Sat, 12 Mar 2011)
New Revision: 69897
URL: http://svn.boost.org/trac/boost/changeset/69897

Log:
Fixed typo/small change
Text files modified: 
   trunk/libs/geometry/doc/about_documentation.qbk |     6 ++++--                                  
   1 files changed, 4 insertions(+), 2 deletions(-)

Modified: trunk/libs/geometry/doc/about_documentation.qbk
==============================================================================
--- trunk/libs/geometry/doc/about_documentation.qbk	(original)
+++ trunk/libs/geometry/doc/about_documentation.qbk	2011-03-12 12:07:13 EST (Sat, 12 Mar 2011)
@@ -58,14 +58,16 @@
 In the example above a QuickBook include statement is used. But any QuickBook code can be used, the QuickBook code does not have to be stored in a separate file. Two more samples:
 
 [pre
-\qbk{
 /*!
+...
+\qbk{
 \[heading Example\]
 \[area_with_strategy\]
 \[area_with_strategy_output\]
 
 \[heading Available Strategies\]
 \[link geometry.reference.strategies.strategy_area_surveyor Surveyor (cartesian)\]
+}
  */
 ]
 
@@ -83,7 +85,7 @@
 [heading Doxygen aliases]
 While documenting a large library, it is unavoidable that you have to document the same parameters in different places. For example, the template parameter [*Geometry], and the variable [*geometry], occur at least 100 times in our library. 
 
-To avoid repeating the same text again and again, Doxygen aliases are used. So \tparam_geometry means that the generic description for a template parameter geometry is inserted. \param_geometry does the same for a parameter. This is all handled by Doxygen itself. Those parameters are sometimes also parameterized, for example: [*\return_calc{area}], being expanded to: ['The calculated area]
+To avoid repeating the same text again and again, Doxygen aliases are used. So \tparam_geometry means that the generic description for a template parameter geometry is inserted. \param_geometry does the same for a parameter. This is all handled by Doxygen itself. The aliases can also be parameterized, for example: [*\return_calc{area}] is expanded to: ['The calculated area]
 
 This is for Doxygen alone and is not related to ['doxygen_xml2qbk] or QuickBook.