[Boost-commit] svn:boost r67780 - in trunk/libs/geometry/doc: . snippets

Subject: [Boost-commit] svn:boost r67780 - in trunk/libs/geometry/doc: . snippets
From: barend.gehrels_at_[hidden]
Date: 2011-01-08 09:38:04

Author: barendgehrels
Date: 2011-01-08 09:38:03 EST (Sat, 08 Jan 2011)
New Revision: 67780
URL: http://svn.boost.org/trac/boost/changeset/67780

Log:
Small doc update
Removed:
   trunk/libs/geometry/doc/snippets/
Text files modified: 
   trunk/libs/geometry/doc/geometry.qbk |     4 ++++                                    
   trunk/libs/geometry/doc/readme.txt   |    15 +++++++++------                         
   2 files changed, 13 insertions(+), 6 deletions(-)

Modified: trunk/libs/geometry/doc/geometry.qbk
==============================================================================
--- trunk/libs/geometry/doc/geometry.qbk	(original)
+++ trunk/libs/geometry/doc/geometry.qbk	2011-01-08 09:38:03 EST (Sat, 08 Jan 2011)
@@ -60,6 +60,10 @@
 
 [*In progress]
 
+Examples of documentation:
+Area algorithm [link geometry.reference.algorithms.area.area_1 here]
+Simplify algorithm [link geometry.reference.algorithms.simplify.simplify_3 here]
+
 [import src/examples/quick_start.cpp]
 [import src/examples/algorithms/area.cpp]
 [import src/examples/algorithms/area_with_strategy.cpp]

Modified: trunk/libs/geometry/doc/readme.txt
==============================================================================
--- trunk/libs/geometry/doc/readme.txt	(original)
+++ trunk/libs/geometry/doc/readme.txt	2011-01-08 09:38:03 EST (Sat, 08 Jan 2011)
@@ -10,17 +10,20 @@
 
 Procedure to create documentation using Doxygen, QuickBook and doxygen_xml2qbk
 
+Note that doxygen_xml2qbk is a tool currently (slightly) specific to Boost.Geometry,
+and that it translates from Doxygen-XML output to Quickbook (without xslt)
+
 1) install Doxygen
-2) install QuickBook using http://www.boost.org/doc/libs/1_44_0/doc/html/quickbook/install.html#quickbook.install.linux
-3) compile doxygen_xml2qbk, in .../boost/sandbox/geometry/other/programs/doxygen_xml2qbk
+2) install QuickBook using http://www.boost.org/doc/libs/1_45_0/doc/html/quickbook/install.html#quickbook.install.linux
+3) compile doxygen_xml2qbk, in src/docutils/tools/doxygen_xml2qbk
 4) put binary somewhere, e.g. in /usr/local/bin/doxygen_xml2qbk
 5) execute python file "make_qbk.py" (calling doxygen, doxygen_xml2qbk, bjam)
 
 Folders in this folder:
+concept: manually written documentation  QBK files, on concept
 doxy: folders and files needed for doxygen input and output
-other: older documentation (subject to update or deletion)
-snippets: code snippets (might be renamed to examples and contain fully runnable examples)
-
-reference: contains generated QBK files (by doxygen_xml2qbk)
 html: contains generated HTML files
+other: older documentation (subject to update or deletion)
+reference: generated documentation QBK files (by doxygen_xml2qbk)
+src: examples used in documentation and tools (doxygen_xml2qbk)