[Boost-commit] svn:boost r48134 - sandbox/SOC/2008/spacial_indexing/libs/spatial_index/doc

From: mariano.consoni_at_[hidden]
Date: 2008-08-13 20:09:58

Author: mconsoni
Date: 2008-08-13 20:09:57 EDT (Wed, 13 Aug 2008)
New Revision: 48134
URL: http://svn.boost.org/trac/boost/changeset/48134

Log:
- More documentation.

Text files modified: 
   sandbox/SOC/2008/spacial_indexing/libs/spatial_index/doc/tutorials.qbk |    17 +++++++++++++++++                       
   1 files changed, 17 insertions(+), 0 deletions(-)

Modified: sandbox/SOC/2008/spacial_indexing/libs/spatial_index/doc/tutorials.qbk
==============================================================================
--- sandbox/SOC/2008/spacial_indexing/libs/spatial_index/doc/tutorials.qbk	(original)
+++ sandbox/SOC/2008/spacial_indexing/libs/spatial_index/doc/tutorials.qbk	2008-08-13 20:09:57 EDT (Wed, 13 Aug 2008)
@@ -9,3 +9,20 @@
 
 [section:tutorial1 Tutorial - Basic usage]
 
+This tutorial describes the basic usage of the Spatial Indexes. We won't use an specific index to
+show the basic usage of  the library. Next tutorials will address specifc index types.
+
+In this tutorial an empty item is created (a quadtree in this example) and some points are added.
+Then we perform two searches and finally some points are removed.
+
+We will follow the first test of our test suite, test/basic_test.cpp
+
+The first step is to create the index. We have to choose which index we'll use. In this case
+we will select the quadtree.
+
+Now that we have chosen our index type, we have to carefully look the constructor. Altough a
+generic interface is defined (in spatial_index.hpp), each index type has its own creation parameters. 
+
+Let's see 
+
+[endsect]