Boost logo

Boost-Commit :

From: mariano.consoni_at_[hidden]
Date: 2008-07-23 14:12:57


Author: mconsoni
Date: 2008-07-23 14:12:56 EDT (Wed, 23 Jul 2008)
New Revision: 47732
URL: http://svn.boost.org/trac/boost/changeset/47732

Log:
- Improved .hpp header comments.

Text files modified:
   sandbox/SOC/2008/spacial_indexing/boost/spatial_index.hpp | 6 ++++++
   sandbox/SOC/2008/spacial_indexing/boost/spatial_index/helpers.hpp | 6 ++++++
   sandbox/SOC/2008/spacial_indexing/boost/spatial_index/quadtree.hpp | 5 +++--
   sandbox/SOC/2008/spacial_indexing/boost/spatial_index/quadtree_node.hpp | 5 +++--
   sandbox/SOC/2008/spacial_indexing/boost/spatial_index/rtree.hpp | 12 +++++++-----
   sandbox/SOC/2008/spacial_indexing/boost/spatial_index/rtree_leaf.hpp | 5 +++--
   sandbox/SOC/2008/spacial_indexing/boost/spatial_index/rtree_node.hpp | 5 +++--
   sandbox/SOC/2008/spacial_indexing/boost/spatial_index/spatial_index.hpp | 6 ++++++
   8 files changed, 37 insertions(+), 13 deletions(-)

Modified: sandbox/SOC/2008/spacial_indexing/boost/spatial_index.hpp
==============================================================================
--- sandbox/SOC/2008/spacial_indexing/boost/spatial_index.hpp (original)
+++ sandbox/SOC/2008/spacial_indexing/boost/spatial_index.hpp 2008-07-23 14:12:56 EDT (Wed, 23 Jul 2008)
@@ -1,7 +1,13 @@
+//
+// Boost.SpatialIndex - main header
+//
 // Copyright 2008 Federico J. Fernandez.
 // Distributed under 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)
+//
+// See http://www.boost.org/ for latest version.
+//
 
 
 #ifndef BOOST_SPATIAL_INDEX_HPP

Modified: sandbox/SOC/2008/spacial_indexing/boost/spatial_index/helpers.hpp
==============================================================================
--- sandbox/SOC/2008/spacial_indexing/boost/spatial_index/helpers.hpp (original)
+++ sandbox/SOC/2008/spacial_indexing/boost/spatial_index/helpers.hpp 2008-07-23 14:12:56 EDT (Wed, 23 Jul 2008)
@@ -1,7 +1,13 @@
+//
+// Boost.SpatialIndex - geometry helper functions
+//
 // Copyright 2008 Federico J. Fernandez.
 // Distributed under 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)
+//
+// See http://www.boost.org/ for latest version.
+//
 
 
 #ifndef BOOST_SPATIAL_INDEX_HELPERS_HPP

Modified: sandbox/SOC/2008/spacial_indexing/boost/spatial_index/quadtree.hpp
==============================================================================
--- sandbox/SOC/2008/spacial_indexing/boost/spatial_index/quadtree.hpp (original)
+++ sandbox/SOC/2008/spacial_indexing/boost/spatial_index/quadtree.hpp 2008-07-23 14:12:56 EDT (Wed, 23 Jul 2008)
@@ -1,12 +1,13 @@
 //
-// Spatial Index - QuadTree
-//
+// Boost.SpatialIndex - quadtree implementation
 //
 // Copyright 2008 Federico J. Fernandez.
 // Distributed under 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)
 //
+// See http://www.boost.org/ for latest version.
+//
 
 
 #ifndef BOOST_SPATIAL_INDEX_QUADTREE_HPP

Modified: sandbox/SOC/2008/spacial_indexing/boost/spatial_index/quadtree_node.hpp
==============================================================================
--- sandbox/SOC/2008/spacial_indexing/boost/spatial_index/quadtree_node.hpp (original)
+++ sandbox/SOC/2008/spacial_indexing/boost/spatial_index/quadtree_node.hpp 2008-07-23 14:12:56 EDT (Wed, 23 Jul 2008)
@@ -1,12 +1,13 @@
 //
-// Spatial Index - QuadTree Node
-//
+// Boost.SpatialIndex - quadtree node implementation
 //
 // Copyright 2008 Federico J. Fernandez.
 // Distributed under 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)
 //
+// See http://www.boost.org/ for latest version.
+//
 
 
 #ifndef BOOST_SPATIAL_INDEX_QUADTREE_NODE_HPP

Modified: sandbox/SOC/2008/spacial_indexing/boost/spatial_index/rtree.hpp
==============================================================================
--- sandbox/SOC/2008/spacial_indexing/boost/spatial_index/rtree.hpp (original)
+++ sandbox/SOC/2008/spacial_indexing/boost/spatial_index/rtree.hpp 2008-07-23 14:12:56 EDT (Wed, 23 Jul 2008)
@@ -1,13 +1,13 @@
 //
-// Spatial Index - rTree
-//
+// Boost.SpatialIndex - rtree implementation
 //
 // Copyright 2008 Federico J. Fernandez.
 // Distributed under 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)
 //
-
+// See http://www.boost.org/ for latest version.
+//
 
 #ifndef BOOST_SPATIAL_INDEX_RTREE_HPP
 #define BOOST_SPATIAL_INDEX_RTREE_HPP
@@ -93,7 +93,8 @@
             insert(it->first, it->second);
           }
 
- // if the root has only one child and the child is not a leaf, make it the root
+ // if the root has only one child and the child is not a leaf,
+ // make it the root
           if (root_->elements() == 1) {
             if (!root_->first_element()->is_leaf()) {
               root_ = root_->first_element();
@@ -484,7 +485,8 @@
           throw std::logic_error("Empty Node trying to Pick Seeds");
         }
         // only two dim for now
- // unsigned int dimensions = geometry::point_traits<Point>::coordinate_count;
+ // unsigned int dimensions =
+ // geometry::point_traits<Point>::coordinate_count;
 
         // find the first two elements
         double separation_x, separation_y;

Modified: sandbox/SOC/2008/spacial_indexing/boost/spatial_index/rtree_leaf.hpp
==============================================================================
--- sandbox/SOC/2008/spacial_indexing/boost/spatial_index/rtree_leaf.hpp (original)
+++ sandbox/SOC/2008/spacial_indexing/boost/spatial_index/rtree_leaf.hpp 2008-07-23 14:12:56 EDT (Wed, 23 Jul 2008)
@@ -1,12 +1,13 @@
 //
-// Spatial Index - rTree Leaf
-//
+// Boost.SpatialIndex - rtree leaf implementation
 //
 // Copyright 2008 Federico J. Fernandez.
 // Distributed under 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)
 //
+// See http://www.boost.org/ for latest version.
+//
 
 
 #ifndef BOOST_SPATIAL_INDEX_RTREE_LEAF_HPP

Modified: sandbox/SOC/2008/spacial_indexing/boost/spatial_index/rtree_node.hpp
==============================================================================
--- sandbox/SOC/2008/spacial_indexing/boost/spatial_index/rtree_node.hpp (original)
+++ sandbox/SOC/2008/spacial_indexing/boost/spatial_index/rtree_node.hpp 2008-07-23 14:12:56 EDT (Wed, 23 Jul 2008)
@@ -1,12 +1,13 @@
 //
-// Spatial Index - rTree Node
-//
+// Boost.SpatialIndex - rtree node implementation
 //
 // Copyright 2008 Federico J. Fernandez.
 // Distributed under 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)
 //
+// See http://www.boost.org/ for latest version.
+//
 
 
 #ifndef BOOST_SPATIAL_INDEX_RTREE_NODE_HPP

Modified: sandbox/SOC/2008/spacial_indexing/boost/spatial_index/spatial_index.hpp
==============================================================================
--- sandbox/SOC/2008/spacial_indexing/boost/spatial_index/spatial_index.hpp (original)
+++ sandbox/SOC/2008/spacial_indexing/boost/spatial_index/spatial_index.hpp 2008-07-23 14:12:56 EDT (Wed, 23 Jul 2008)
@@ -1,7 +1,13 @@
+//
+// Boost.SpatialIndex - spatial index interface
+//
 // Copyright 2008 Federico J. Fernandez.
 // Distributed under 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)
+//
+// See http://www.boost.org/ for latest version.
+//
 
 
 #ifndef BOOST_SPATIAL_INDEX_SPATIAL_INDEX_HPP


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