[Boost-commit] svn:boost r68680 - trunk/libs/geometry/doc/ref/core

Subject: [Boost-commit] svn:boost r68680 - trunk/libs/geometry/doc/ref/core
From: barend.gehrels_at_[hidden]
Date: 2011-02-06 16:03:57

Author: barendgehrels
Date: 2011-02-06 16:03:56 EST (Sun, 06 Feb 2011)
New Revision: 68680
URL: http://svn.boost.org/trac/boost/changeset/68680

Log:
Added set/get doc
Added:
   trunk/libs/geometry/doc/ref/core/
   trunk/libs/geometry/doc/ref/core/get_box.qbk   (contents, props changed)
   trunk/libs/geometry/doc/ref/core/get_point.qbk   (contents, props changed)
   trunk/libs/geometry/doc/ref/core/set_box.qbk   (contents, props changed)
   trunk/libs/geometry/doc/ref/core/set_point.qbk   (contents, props changed)

Added: trunk/libs/geometry/doc/ref/core/get_box.qbk
==============================================================================
--- (empty file)
+++ trunk/libs/geometry/doc/ref/core/get_box.qbk	2011-02-06 16:03:56 EST (Sun, 06 Feb 2011)
@@ -0,0 +1,23 @@
+[/============================================================================
+  Boost.Geometry (aka GGL, Generic Geometry Library)
+
+  Copyright (c) 2009-2011 Barend Gehrels, Geodan, Amsterdam, the Netherlands.
+
+  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)
+=============================================================================/]
+
+[heading Behavior]
+[table
+[[Case] [Behavior] ]
+[[__box__][Returns the coordinate of a box (use min_corner, max_corner to specify which of the points to set) ]]
+[[__segment__][Returns the coordinate of a segment (use 0, 1 to specify which of the two points to set) ]]
+]
+
+[heading Complexity]
+Constant
+
+[heading Example]
+[get_box]
+[get_box_output]

Added: trunk/libs/geometry/doc/ref/core/get_point.qbk
==============================================================================
--- (empty file)
+++ trunk/libs/geometry/doc/ref/core/get_point.qbk	2011-02-06 16:03:56 EST (Sun, 06 Feb 2011)
@@ -0,0 +1,25 @@
+[/============================================================================
+  Boost.Geometry (aka GGL, Generic Geometry Library)
+
+  Copyright (c) 2009-2011 Barend Gehrels, Geodan, Amsterdam, the Netherlands.
+
+  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)
+=============================================================================/]
+
+
+[heading Behavior]
+[table
+[[Case] [Behavior] ]
+[[__point__][Returns the coordinate of a point]]
+[[Circle or Sphere][Returns the coordinate of the center of a circle or sphere (currently in an extension)]]
+[[__sph__][Returns the coordinate of a point, in either Radian's or Degree's, depending on specified units]]
+]
+
+[heading Complexity]
+Constant
+
+[heading Example]
+[get_point]
+[get_point_output]

Added: trunk/libs/geometry/doc/ref/core/set_box.qbk
==============================================================================
--- (empty file)
+++ trunk/libs/geometry/doc/ref/core/set_box.qbk	2011-02-06 16:03:56 EST (Sun, 06 Feb 2011)
@@ -0,0 +1,23 @@
+[/============================================================================
+  Boost.Geometry (aka GGL, Generic Geometry Library)
+
+  Copyright (c) 2009-2011 Barend Gehrels, Geodan, Amsterdam, the Netherlands.
+
+  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)
+=============================================================================/]
+
+[heading Behavior]
+[table
+[[Case] [Behavior] ]
+[[__box__][Sets the coordinate of a box (use min_corner, max_corner to specify which of the points to set) ]]
+[[__segment__][Sets the coordinate of a segment (use 0, 1 to specify which of the two points to set) ]]
+]
+
+[heading Complexity]
+Constant
+
+[heading Example]
+[set_box]
+[set_box_output]

Added: trunk/libs/geometry/doc/ref/core/set_point.qbk
==============================================================================
--- (empty file)
+++ trunk/libs/geometry/doc/ref/core/set_point.qbk	2011-02-06 16:03:56 EST (Sun, 06 Feb 2011)
@@ -0,0 +1,25 @@
+[/============================================================================
+  Boost.Geometry (aka GGL, Generic Geometry Library)
+
+  Copyright (c) 2009-2011 Barend Gehrels, Geodan, Amsterdam, the Netherlands.
+
+  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)
+=============================================================================/]
+
+
+[heading Behavior]
+[table
+[[Case] [Behavior] ]
+[[__point__][Sets the coordinate of a point]]
+[[Circle or Sphere][Sets the coordinate of the center of a circle or sphere (currently in an extension)]]
+[[__sph__][Sets the coordinate of a point, in either Radian's or Degree's, depending on specified units]]
+]
+
+[heading Complexity]
+Constant
+
+[heading Example]
+[set_point]
+[set_point_output]