[Liblas-commits] r1232 - trunk/include/liblas

[liblas-commits at liblas.org]

Author: mloskot
Date: Fri Apr 17 07:14:59 2009
New Revision: 1232
URL: http://liblas.org/changeset/1232

Log:
Updated docs.

Modified:
   trunk/include/liblas/lasclassification.hpp

Modified: trunk/include/liblas/lasclassification.hpp
==============================================================================
--- trunk/include/liblas/lasclassification.hpp	(original)
+++ trunk/include/liblas/lasclassification.hpp	Fri Apr 17 07:14:59 2009
@@ -70,12 +70,13 @@
     /// table is supported.
     static std::size_t const class_table_size;
 
+    /// Values of indexes in the set of bit flags.
     enum BitPosition
     {
-        eClassBit     = 0, /// First bit position of 0:4 range.
-        eSyntheticBit = 5, /// Synthetic flag.
-        eKeyPointBit  = 6, /// Key-point flag.
-        eWithheldBit  = 7  /// Withheld flag.
+        eClassBit     = 0, ///< First bit position of 0:4 range.
+        eSyntheticBit = 5, ///< Synthetic flag.
+        eKeyPointBit  = 6, ///< Key-point flag.
+        eWithheldBit  = 7  ///< Withheld flag.
     };
 
     /// Default initialization constructor.
@@ -98,9 +99,9 @@
     /// Initializes classification with values of given compounds.
     /// @param cls [in] - index of Standard ASPRS classification as
     /// defined in the lookup table, from 0 to class_table_size - 1.
-    /// @param s [in] - If set then this point was created by a technique other than
+    /// @param s [in] - If set then this point was created by a technique other than
     /// LIDAR collection such as digitized from a photogrammetric stereo model.
-    /// @param k [in] - If set, this point is considered to be a model keypoint and
+    /// @param k [in] - If set, this point is considered to be a model keypoint and
     /// thus generally should not be withheld in a thinning algorithm.
     /// @param w [in] - If set, this point should not be included in processing.
     LASClassification(uint8_t cls, bool s, bool k, bool w)
@@ -188,7 +189,7 @@
         return m_flags[eSyntheticBit];
     }
 
-    /// Sets if this point is considered to be a model keypoint and
+    /// Sets if this point is considered to be a model keypoint and
     /// thus generally should not be withheld in a thinning algorithm.
     void SetKeyPoint(bool flag)
     {