[MOAB-dev] r4320 - MOAB/trunk/src/moab

[tautges at mcs.anl.gov]

Author: tautges
Date: 2010-12-03 12:56:49 -0600 (Fri, 03 Dec 2010)
New Revision: 4320

Modified:
   MOAB/trunk/src/moab/AdaptiveKDTree.hpp
   MOAB/trunk/src/moab/BSPTree.hpp
   MOAB/trunk/src/moab/Core.hpp
   MOAB/trunk/src/moab/GeomTopoTool.hpp
   MOAB/trunk/src/moab/GeomUtil.hpp
   MOAB/trunk/src/moab/HigherOrderFactory.hpp
   MOAB/trunk/src/moab/HomXform.hpp
   MOAB/trunk/src/moab/OrientedBoxTreeTool.hpp
   MOAB/trunk/src/moab/Skinner.hpp
   MOAB/trunk/src/moab/Util.hpp
Log:
Adding class documentation in a number of places.  Fixes ticket #166.



Modified: MOAB/trunk/src/moab/AdaptiveKDTree.hpp
===================================================================
--- MOAB/trunk/src/moab/AdaptiveKDTree.hpp	2010-12-03 18:30:25 UTC (rev 4319)
+++ MOAB/trunk/src/moab/AdaptiveKDTree.hpp	2010-12-03 18:56:49 UTC (rev 4320)
@@ -14,8 +14,10 @@
  */
 
 /**\file AdaptiveKDTree.hpp
+ * \class moab::AdaptiveKDTree
  *\author Jason Kraftcheck (kraftche at cae.wisc.edu)
  *\date 2007-04-1
+ * \brief Adaptive KD tree, for sorting and searching entities spatially
  */
 
 #ifndef MOAB_ADAPTIVE_KD_TREE_HPP

Modified: MOAB/trunk/src/moab/BSPTree.hpp
===================================================================
--- MOAB/trunk/src/moab/BSPTree.hpp	2010-12-03 18:30:25 UTC (rev 4319)
+++ MOAB/trunk/src/moab/BSPTree.hpp	2010-12-03 18:56:49 UTC (rev 4320)
@@ -13,7 +13,7 @@
  * 
  */
 
-/**\file AdaptiveKDTree.hpp
+/**\file BSPTree.hpp
  *\author Jason Kraftcheck (kraftche at cae.wisc.edu)
  *\date 2008-05-12
  */
@@ -35,6 +35,9 @@
 class Range;
 class BSPTreePoly;
 
+/** \class BSPTree
+ * \brief BSP tree, for sorting and searching entities spatially
+ */
 class BSPTree
 {
 private:
@@ -225,6 +228,9 @@
                                      BSPTreeIter& result );
 };
 
+/** \class BSPTreeIter
+ * \brief Iterate over leaves of a BSPTree
+ */
 class BSPTreeIter
 {
 public:
@@ -328,6 +334,9 @@
   virtual ErrorCode calculate_polyhedron( BSPTreePoly& polyhedron_out ) const;