Skip to content

Commit

Permalink
Doxygen updates
Browse files Browse the repository at this point in the history
  • Loading branch information
Armin Hornung committed Jan 21, 2013
1 parent 88853c5 commit 409ce68
Show file tree
Hide file tree
Showing 4 changed files with 1,109 additions and 587 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ html
lib
bin
build
callgrind.out*

# in case someone runs an in-source build:
CMakeCache.txt
Expand Down
23 changes: 14 additions & 9 deletions octomap/doxygen.h
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@

/**
* \namespace octomath Namespace of the math library in Octomap
* \namespace octomath Namespace of the math library in OctoMap
*
*/


/**
* \namespace octomap Namespace the Octomap library and visualization tools
* \namespace octomap Namespace the OctoMap library and visualization tools
*
*/


/** \mainpage Octomap
/** \mainpage OctoMap
\section intro_sec Introduction
The <a href="http://octomap.github.com/">Octomap library</a>
The <a href="http://octomap.github.com/">OctoMap library</a>
implements a 3D occupancy grid mapping approach. It provides data
structures and mapping algorithms. The map is implemented using an
\ref octomap::OcTree "Octree". It is designed to meet the following
Expand Down Expand Up @@ -77,16 +77,21 @@ You can find an overview at http://octomap.github.com/ and the code repository a
\section gettingstarted_sec Getting Started
<p>
Jump right in and have a look at the main class octomap::OcTree and the examples in src/octomap/simple.cpp.
Jump right in and have a look at the main class \ref octomap::OcTree 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(...). The preferred way to batch-access or process nodes in an Octree is with the iterators
\ref octomap::OcTree::insertRay "OcTree::insertRay(...)", to insert full 3D scans (pointclouds) please have a look at
\ref octomap::OcTree::insertScan "OcTree::insertScan(...)". Queries can be performed e.g. with \ref octomap::OcTree::search "OcTree::search(...)" or
\ref octomap::OcTree::castRay(...) "OcTree::castRay(...)". The preferred way to batch-access or process nodes in an Octree is with the iterators
\ref leaf_iterator "leaf_iterator", \ref tree_iterator "tree_iterator", or \ref leaf_bbx_iterator "leaf_bbx_iterator".</p>
\image html uml_overview.png
<p>The \ref octomap::OcTree "OcTree" class is derived from \ref octomap::OccupancyOcTreeBase "OccupancyOcTreeBase", with most
functionality in the parent class. Also derive from OccupancyOcTreeBase if you you want to implement
your own Octree and node classes. You can have a look at the classes octomap::OcTreeStamped and octomap::OcTreeNodeStamped as examples.
your own Octree and node classes. You can have a look at the classes \ref octomap::OcTreeStamped "OcTreeStamped" and \ref octomap::OcTreeNodeStamped "OcTreeNodeStamped" as examples.
</p>
Expand Down
Loading

0 comments on commit 409ce68

Please sign in to comment.