Final cleanup for 1.0 release (documentation)

FrankXie05 · Mar 14, 2011 · f1646cb · f1646cb
1 parent 14b7f77
commit f1646cb
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 20 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -2,8 +2,8 @@ CMAKE_MINIMUM_REQUIRED(VERSION 2.6)
 PROJECT( octomap )
 
 # version (e.g. for packaging)
-set(V_MAJOR 0)
-set(V_MINOR 9)
+set(V_MAJOR 1)
+set(V_MINOR 0)
 set(V_PATCH 0)
 
 # get rid of a useless warning:

diff --git a/README.txt b/README.txt
@@ -20,7 +20,7 @@ REQUIREMENTS
 ############################
 
  * cmake
- * regular build environment
+ * regular build environment (gcc)
 
  viewer: 
  * Qt4
@@ -116,5 +116,7 @@ http://www.vtk.org/Wiki/Eclipse_CDT4_Generator) by running:
 	cmake -G"Eclipse CDT4 - Unix Makefiles" ..
 
 Import the project (existing project, root is the build folder, 
-do not copy contents) into Eclipse afterwards.
+do not copy contents) into Eclipse afterwards. For full Eclipse
+compatibility, it might be necessary to build in the main source
+directory.
 
diff --git a/doxygen.h b/doxygen.h
@@ -69,11 +69,11 @@ Hornung</a>. Feel free to contact us.</p>
 
 \section gettingstarted_sec Getting Started
 <p>
-  Jump right in and have a look at the main class octomap::OcTree and the examples<br>
-  src/octomap/simple.cpp. To integrate single measurements into the 3D map have a look at
-  octomap::Octree::insertRay(...), to insert full 3D scans (pointclouds) please have a look at
-  octomap::Octree::insertScan(). Queries can be performed e.g. with octomap::Octree::search(...) or
-  octomap::Octree::castRay(...).
+  Jump right in and have a look at the main class octomap::OcTree and the examples in src/octomap/simple.cpp. 
+  To integrate single measurements into the 3D map have a look at
+  octomap::OcTree::insertRay(...), to insert full 3D scans (pointclouds) please have a look at
+  octomap::OcTree::insertScan(). Queries can be performed e.g. with octomap::OcTree::search(...) or
+  octomap::OcTree::castRay(...).
 </p>
 
 <p>

diff --git a/include/octomap/OcTreeBase.h b/include/octomap/OcTreeBase.h
@@ -208,21 +208,18 @@ namespace octomap {
     bool genKey(const point3d& point, OcTreeKey& key) const;
 
 
-    // -- experimental section  -----------------------
     // file IO
 
     /// Read complete state of tree from stream
-    /// EXPERIMENTAL!
     std::istream& read(std::istream &s);
 
     /// Write complete state of tree to stream, prune tree first (lossless compression)
-    /// EXPERIMENTAL!
     std::ostream& write(std::ostream &s);
 
     /// Write complete state of tree to stream, no pruning (const version)
     std::ostream& writeConst(std::ostream &s) const;
 
-    /// Make the templated NODE type available from the outside
+    /// Make the templated NODE type available to the outside
     typedef NODE NodeType;
 
  protected:
@@ -295,8 +292,8 @@ namespace octomap {
     NODE* itsRoot;
 
     // constants of the tree
-    unsigned int tree_depth;
-    unsigned int tree_max_val;
+    const unsigned int tree_depth;
+    const unsigned int tree_max_val;
     double resolution;  ///< in meters
     double resolution_factor; ///< = 1. / resolution
 

diff --git a/include/octomap/OcTreeDataNode.h b/include/octomap/OcTreeDataNode.h
@@ -112,8 +112,6 @@ namespace octomap {
      * Read node from binary stream (incl. float value),
      * recursively continue with all children.
      *
-     * @note This is an experimental feature!
-     *
      * @param s
      * @return
      */
@@ -124,15 +122,13 @@ namespace octomap {
      * recursively continue with all children.
      * This preserves the complete state of the node.
      *
-     * @note This is an experimental feature!
-     *
      * @param s
      * @return
      */
     std::ostream& writeValue(std::ostream &s) const;
 
 
-    /// Make the templated data type available from the outside
+    /// Make the templated data type available to the outside
     typedef T DataType;