|
|
Boost-Commit : |
Subject: [Boost-commit] svn:boost r67517 - in trunk/libs/geometry: doc doc/snippets test
From: barend.gehrels_at_[hidden]
Date: 2010-12-31 08:32:10
Author: barendgehrels
Date: 2010-12-31 08:32:08 EST (Fri, 31 Dec 2010)
New Revision: 67517
URL: http://svn.boost.org/trac/boost/changeset/67517
Log:
Doc update
Removed:
trunk/libs/geometry/doc/make_qbk.bat
trunk/libs/geometry/doc/make_qbk.sh
Text files modified:
trunk/libs/geometry/doc/Jamfile.v2 | 5 +++--
trunk/libs/geometry/doc/make_qbk.py | 22 +++++++++++-----------
trunk/libs/geometry/doc/quickref.xml | 2 +-
trunk/libs/geometry/doc/readme.txt | 14 --------------
trunk/libs/geometry/doc/reference.qbk | 38 ++++++++++++++++++++------------------
trunk/libs/geometry/doc/snippets/boost.vsprops | 2 +-
trunk/libs/geometry/doc/snippets/qbk_2.cpp | 2 +-
trunk/libs/geometry/test/boost.vsprops | 2 +-
trunk/libs/geometry/test/ttmath.vsprops | 2 +-
9 files changed, 39 insertions(+), 50 deletions(-)
Modified: trunk/libs/geometry/doc/Jamfile.v2
==============================================================================
--- trunk/libs/geometry/doc/Jamfile.v2 (original)
+++ trunk/libs/geometry/doc/Jamfile.v2 2010-12-31 08:32:08 EST (Fri, 31 Dec 2010)
@@ -23,8 +23,9 @@
<xsl:param>toc.section.depth=3
<xsl:param>toc.max.depth=2
<xsl:param>generate.section.toc.level=4
- <xsl:param>boost.root=../../..
- <xsl:param>callout.graphics.path=../../../../doc/src/images/callouts/
+ <xsl:param>boost.root=../../../..
+ <xsl:param>navig.graphics.path=../../../../doc/src/images/
+ <xsl:param>callout.graphics.path=../../../../doc/src/images/callouts/
;
Deleted: trunk/libs/geometry/doc/make_qbk.bat
==============================================================================
--- trunk/libs/geometry/doc/make_qbk.bat 2010-12-31 08:32:08 EST (Fri, 31 Dec 2010)
+++ (empty file)
@@ -1,77 +0,0 @@
-:: ===========================================================================
-:: Copyright (c) 1995-2010 Barend Gehrels, Geodan, Amsterdam, the Netherlands.
-:: Copyright (c) 2008-2010 Bruno Lalande, Paris, France.
-:: Copyright (c) 2009-2010 Mateusz Loskot (mateusz_at_[hidden]), London, UK
-::
-:: Use, modification and distribution is subject to the Boost Software License,
-:: Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
-:: http://www.boost.org/LICENSE_1_0.txt)
-:: ============================================================================
-
-:: Note, all of this is very experimental
-:: BSG, Aug 1, 2010
-
-
-_at_echo off
-
-if a%1 == askip_doxygen goto skip_doxygen
-
-cd ..
-doxygen
-cd qbk
-
-:skip_doxygen
-
-set xml2qbk=..\..\..\..\other\programs\doxygen_xml2qbk\Release\doxygen_xml2qbk.exe
-set out=..\doxygen_output\xml
-set config=../../../../ boost/geometry/geometry.hpp boost/geometry/geometries/geometries.hpp boost/geometry/multi/multi.hpp
-
-:: Algorithms
-%xml2qbk% %out%\group__area.xml %config% > reference\area.qbk
-%xml2qbk% %out%\group__buffer.xml %config% > reference\buffer.qbk
-%xml2qbk% %out%\group__centroid.xml %config% > reference\centroid.qbk
-%xml2qbk% %out%\group__convex__hull.xml %config% > reference\convex_hull.qbk
-%xml2qbk% %out%\group__dissolve.xml %config% > reference\dissolve.qbk
-%xml2qbk% %out%\group__envelope.xml %config% > reference\envelope.qbk
-%xml2qbk% %out%\group__length.xml %config% > reference\length.qbk
-%xml2qbk% %out%\group__num__geometries.xml %config% > reference\num_geometries.qbk
-%xml2qbk% %out%\group__num__interior__rings.xml %config% > reference\num_interior_rings.qbk
-%xml2qbk% %out%\group__num__points.xml %config% > reference\num_points.qbk
-%xml2qbk% %out%\group__perimeter.xml %config% > reference\perimeter.qbk
-%xml2qbk% %out%\group__reverse.xml %config% > reference\reverse.qbk
-%xml2qbk% %out%\group__simplify.xml %config% > reference\simplify.qbk
-%xml2qbk% %out%\group__unique.xml %config% > reference\unique.qbk
-:: %xml2qbk% %out%\group__access.xml %config% > reference\access.qbk
-:: %xml2qbk% %out%\group__combine.xml %config% > reference\combine.qbk
-:: %xml2qbk% %out%\group__convert.xml %config% > reference\convert.qbk
-:: %xml2qbk% %out%\group__difference.xml %config% > reference\difference.qbk
-:: %xml2qbk% %out%\group__disjoint.xml %config% > reference\disjoint.qbk
-%xml2qbk% %out%\group__distance.xml %config% > reference\distance.qbk
-:: %xml2qbk% %out%\group__equals.xml %config% > reference\equals.qbk
-:: %xml2qbk% %out%\group__for__each.xml %config% > reference\for_each.qbk
-%xml2qbk% %out%\group__intersection.xml %config% > reference\intersection.qbk
-%xml2qbk% %out%\group__intersects.xml %config% > reference\intersects.qbk
-:: %xml2qbk% %out%\group__overlaps.xml %config% > reference\overlaps.qbk
-:: %xml2qbk% %out%\group__sym__difference.xml %config% > reference\sym_difference.qbk
-:: %xml2qbk% %out%\group__transform.xml %config% > reference\transform.qbk
-:: %xml2qbk% %out%\group__union.xml %config% > reference\union.qbk
-%xml2qbk% %out%\group__within.xml %config% > reference\within.qbk
-
-%xml2qbk% %out%\group__register.xml %config% > reference\register.qbk
-
-
-%xml2qbk% %out%\classboost_1_1geometry_1_1point.xml %config% > reference\point.qbk
-%xml2qbk% %out%\classboost_1_1geometry_1_1point__xy.xml %config% > reference\point_xy.qbk
-
-%xml2qbk% %out%\classboost_1_1geometry_1_1concept_1_1_point.xml %config% > reference\concept_point.qbk
-
-%xml2qbk% %out%\structboost_1_1geometry_1_1closing__iterator.xml %config% > reference\closing_iterator.qbk
-
-:: set xslt=c:\software\xsltproc\xml\bin\xsltproc.exe
-:: %xslt% reference.xsl doxygen_output\xml\classboost_1_1geometry_1_1point.xml > point.qbk
-:: %xslt% reference.xsl doxygen_output\xml\group__area.xml > area.qbk
-:: %xslt% reference.xsl doxygen_output\xml\area_8hpp.xml > area2.qbk
-
-bjam --toolset=msvc --without-python
-
-:end
Modified: trunk/libs/geometry/doc/make_qbk.py
==============================================================================
--- trunk/libs/geometry/doc/make_qbk.py (original)
+++ trunk/libs/geometry/doc/make_qbk.py 2010-12-31 08:32:08 EST (Fri, 31 Dec 2010)
@@ -41,24 +41,24 @@
os.system(cmd % ("group__simplify", "simplify"))
os.system(cmd % ("group__unique", "unique"))
-# os.system(cmd % ("group__access.xml", "access.qbk"))
-# os.system(cmd % ("group__combine.xml", "combine.qbk"))
-# os.system(cmd % ("group__convert.xml", "convert.qbk"))
-# os.system(cmd % ("group__difference.xml", "difference.qbk"))
-# os.system(cmd % ("group__disjoint.xml", "disjoint.qbk"))
+# os.system(cmd % ("group__access.xml", "access"))
+# os.system(cmd % ("group__combine.xml", "combine"))
+# os.system(cmd % ("group__convert.xml", "convert"))
+os.system(cmd % ("group__difference.xml", "difference"))
+# os.system(cmd % ("group__disjoint.xml", "disjoint"))
os.system(cmd % ("group__distance", "distance"))
-# os.system(cmd % ("group__equals.xml", "equals.qbk"))
-# os.system(cmd % ("group__for__each.xml", "for_each.qbk"))
+# os.system(cmd % ("group__equals.xml", "equals"))
+# os.system(cmd % ("group__for__each.xml", "for_each"))
os.system(cmd % ("group__intersection", "intersection"))
os.system(cmd % ("group__intersects", "intersects"))
-# os.system(cmd % ("group__overlaps.xml", "overlaps.qbk"))
-# os.system(cmd % ("group__sym__difference.xml", "sym_difference.qbk"))
-# os.system(cmd % ("group__transform.xml", "transform.qbk"))
-# os.system(cmd % ("group__union.xml", "union.qbk"))
+os.system(cmd % ("group__overlaps.xml", "overlaps"))
+os.system(cmd % ("group__sym__difference.xml", "sym_difference"))
+os.system(cmd % ("group__transform.xml", "transform"))
+os.system(cmd % ("group__union.xml", "union"))
os.system(cmd % ("group__within", "within"))
os.system(cmd % ("group__register", "register"))
Deleted: trunk/libs/geometry/doc/make_qbk.sh
==============================================================================
--- trunk/libs/geometry/doc/make_qbk.sh 2010-12-31 08:32:08 EST (Fri, 31 Dec 2010)
+++ (empty file)
@@ -1,61 +0,0 @@
-# ===========================================================================
-# Copyright (c) 1995-2010 Barend Gehrels, Geodan, Amsterdam, the Netherlands.
-# Copyright (c) 2008-2010 Bruno Lalande, Paris, France.
-# Copyright (c) 2009-2010 Mateusz Loskot (mateusz_at_[hidden]), London, UK
-#
-# Use, modification and distribution is subject to the Boost Software License,
-# Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
-# http://www.boost.org/LICENSE_1_0.txt)
-# ============================================================================
-
-cd ..
-doxygen
-cd qbk
-
-# Assume that doxygen_xml2qbk is in /usr/local/bin
-export out=../doxygen_output/xml
-
-# Algorithms
-doxygen_xml2qbk $out/group__area.xml > reference/area.qbk
-doxygen_xml2qbk $out/group__buffer.xml > reference/buffer.qbk
-doxygen_xml2qbk $out/group__centroid.xml > reference/centroid.qbk
-doxygen_xml2qbk $out/group__convex__hull.xml > reference/convex_hull.qbk
-doxygen_xml2qbk $out/group__dissolve.xml > reference/dissolve.qbk
-doxygen_xml2qbk $out/group__envelope.xml > reference/envelope.qbk
-doxygen_xml2qbk $out/group__length.xml > reference/length.qbk
-doxygen_xml2qbk $out/group__num__geometries.xml > reference/num_geometries.qbk
-doxygen_xml2qbk $out/group__num__interior__rings.xml > reference/num_interior_rings.qbk
-doxygen_xml2qbk $out/group__num__points.xml > reference/num_points.qbk
-doxygen_xml2qbk $out/group__perimeter.xml > reference/perimeter.qbk
-doxygen_xml2qbk $out/group__reverse.xml > reference/reverse.qbk
-doxygen_xml2qbk $out/group__simplify.xml > reference/simplify.qbk
-doxygen_xml2qbk $out/group__unique.xml > reference/unique.qbk
-# doxygen_xml2qbk $out/group__access.xml > reference/access.qbk
-# doxygen_xml2qbk $out/group__combine.xml > reference/combine.qbk
-# doxygen_xml2qbk $out/group__convert.xml > reference/convert.qbk
-# doxygen_xml2qbk $out/group__difference.xml > reference/difference.qbk
-# doxygen_xml2qbk $out/group__disjoint.xml > reference/disjoint.qbk
-doxygen_xml2qbk $out/group__distance.xml > reference/distance.qbk
-# doxygen_xml2qbk $out/group__equals.xml > reference/equals.qbk
-# doxygen_xml2qbk $out/group__for__each.xml > reference/for_each.qbk
-doxygen_xml2qbk $out/group__intersection.xml > reference/intersection.qbk
-doxygen_xml2qbk $out/group__intersects.xml > reference/intersects.qbk
-# doxygen_xml2qbk $out/group__overlaps.xml > reference/overlaps.qbk
-# doxygen_xml2qbk $out/group__sym__difference.xml > reference/sym_difference.qbk
-# doxygen_xml2qbk $out/group__transform.xml > reference/transform.qbk
-# doxygen_xml2qbk $out/group__union.xml > reference/union.qbk
-doxygen_xml2qbk $out/group__within.xml > reference/within.qbk
-
-doxygen_xml2qbk $out/group__register.xml > reference/register.qbk
-
-
-doxygen_xml2qbk $out/classboost_1_1geometry_1_1point.xml > reference/point.qbk
-doxygen_xml2qbk $out/classboost_1_1geometry_1_1point__xy.xml > reference/point_xy.qbk
-
-doxygen_xml2qbk $out/classboost_1_1geometry_1_1concept_1_1_point.xml > reference/concept_point.qbk
-
-doxygen_xml2qbk $out/structboost_1_1geometry_1_1closing__iterator.xml > reference/closing_iterator.qbk
-
-bjam --toolset=gcc --without-python
-echo Please ignore for the moment the IDs which are not found
-
Modified: trunk/libs/geometry/doc/quickref.xml
==============================================================================
--- trunk/libs/geometry/doc/quickref.xml (original)
+++ trunk/libs/geometry/doc/quickref.xml 2010-12-31 08:32:08 EST (Fri, 31 Dec 2010)
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE library PUBLIC "-//Boost//DTD BoostBook XML V1.0//EN"
- "../../../../tools/boostbook/dtd/boostbook.dtd">
+ "../../../tools/boostbook/dtd/boostbook.dtd">
<!--
Modified: trunk/libs/geometry/doc/readme.txt
==============================================================================
--- trunk/libs/geometry/doc/readme.txt (original)
+++ trunk/libs/geometry/doc/readme.txt 2010-12-31 08:32:08 EST (Fri, 31 Dec 2010)
@@ -8,20 +8,6 @@
http://www.boost.org/LICENSE_1_0.txt)
============================================================================
-To generate the documentation, simulate as if it is already in Boost.Trunk,
-by adding boostbook.dtd and html/callouts/etc,
-
-So folder structure should be like
-
-.../boost/sandbox/geometry/boost [normal]
-.../boost/sandbox/geometry/libs [normal]
-.../boost/sandbox/geometry/other [normal]
-
-.../boost/sandbox/geometry/libs/doc/html/images/* [copy files from boost trunk]
-.../boost/sandbox/geometry/libs/doc/html/images/callouts/* [copy files from boost trunk]
-.../boost/sandbox/geometry/tools/boostbook/dtd/boostbook.dtd [copy file from boost trunk]
-
-
Procedure to create documentation using Doxygen, QuickBook and doxygen_xml2qbk
1) install Doxygen
Modified: trunk/libs/geometry/doc/reference.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference.qbk (original)
+++ trunk/libs/geometry/doc/reference.qbk 2010-12-31 08:32:08 EST (Fri, 31 Dec 2010)
@@ -28,14 +28,19 @@
[include reference/convex_hull.qbk]
[endsect]
-[/section:difference difference]
-[/include reference/difference.qbk]
-[/endsect]
+[section:difference difference]
+[include reference/difference.qbk]
+[endsect]
[/section:disjoint disjoint]
[/include reference/disjoint.qbk]
[/endsect]
+[section:dissolve dissolve]
+[include reference/dissolve.qbk]
+[endsect]
+
+
[section:distance distance]
[include reference/distance.qbk]
[endsect]
@@ -66,9 +71,9 @@
[include reference/num_points.qbk]
-[/section:overlaps overlaps]
-[/include reference/overlaps.qbk]
-[/endsect]
+[section:overlaps overlaps]
+[include reference/overlaps.qbk]
+[endsect]
[section:perimeter perimeter]
[include reference/perimeter.qbk]
@@ -80,18 +85,18 @@
[include reference/simplify.qbk]
[endsect]
-[/section:sym_difference sym_difference]
-[/include reference/sym_difference.qbk]
-[/endsect]
+[section:sym_difference sym_difference]
+[include reference/sym_difference.qbk]
+[endsect]
-[/section:transform transform]
-[/include reference/transform.qbk]
-[/endsect]
+[section:transform transform]
+[include reference/transform.qbk]
+[endsect]
-[/section:union union]
-[/include reference/union.qbk]
-[/endsect]
+[section:union union]
+[include reference/union.qbk]
+[endsect]
[include reference/unique.qbk]
@@ -104,9 +109,6 @@
-
-
-
[section:concepts Concepts]
[section:concept_point point]
Modified: trunk/libs/geometry/doc/snippets/boost.vsprops
==============================================================================
--- trunk/libs/geometry/doc/snippets/boost.vsprops (original)
+++ trunk/libs/geometry/doc/snippets/boost.vsprops 2010-12-31 08:32:08 EST (Fri, 31 Dec 2010)
@@ -15,6 +15,6 @@
/>
<UserMacro
Name="BOOST_ROOT"
- Value="c:\software\boost_1_45_0"
+ Value="../../../.."
/>
</VisualStudioPropertySheet>
Modified: trunk/libs/geometry/doc/snippets/qbk_2.cpp
==============================================================================
--- trunk/libs/geometry/doc/snippets/qbk_2.cpp (original)
+++ trunk/libs/geometry/doc/snippets/qbk_2.cpp 2010-12-31 08:32:08 EST (Fri, 31 Dec 2010)
@@ -98,7 +98,7 @@
//` Other often used algorithms are point-in-polygon:
double points[][2] = {{2.0, 1.3}, {4.1, 3.0}, {5.3, 2.6}, {2.9, 0.7}, {2.0, 1.3}};
- model::d2::polygon poly;
+ model::polygon<model::d2::point_xy<double> > poly;
append(poly, points);
boost::tuple<double, double> p = boost::make_tuple(3.7, 2.0);
std::cout << "Point p is in polygon? " << (within(p, poly) ? "YES" : "NO") << std::endl;
Modified: trunk/libs/geometry/test/boost.vsprops
==============================================================================
--- trunk/libs/geometry/test/boost.vsprops (original)
+++ trunk/libs/geometry/test/boost.vsprops 2010-12-31 08:32:08 EST (Fri, 31 Dec 2010)
@@ -16,6 +16,6 @@
/>
<UserMacro
Name="BOOST_ROOT"
- Value="C:\software\boost_1_45_0"
+ Value="../../.."
/>
</VisualStudioPropertySheet>
Modified: trunk/libs/geometry/test/ttmath.vsprops
==============================================================================
--- trunk/libs/geometry/test/ttmath.vsprops (original)
+++ trunk/libs/geometry/test/ttmath.vsprops 2010-12-31 08:32:08 EST (Fri, 31 Dec 2010)
@@ -11,6 +11,6 @@
/>
<UserMacro
Name="TTMATH_ROOT"
- Value="c:\_svn\boost\sandbox\geometry\boost\geometry\extensions\contrib\ttmath"
+ Value="..\..\..\boost\geometry\extensions\contrib\ttmath"
/>
</VisualStudioPropertySheet>
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