Changeset 953

Timestamp:

10/30/08 04:35:29 (2 months ago)

Author:

mloskot

Message:

Expose TODO entries in .c and .cpp files from doxygen comments in headers, to not to forget about them.

Location:

trunk

Files:

• include/liblas/capi/liblas.h (modified) (1 diff)
• include/liblas/lasheader.hpp (modified) (3 diffs)
• include/liblas/laspoint.hpp (modified) (2 diffs)
• include/liblas/lasreader.hpp (modified) (1 diff)
• include/liblas/laswriter.hpp (modified) (1 diff)
• src/lasreader.cpp (modified) (1 diff)
• src/laswriter.cpp (modified) (1 diff)

trunk/include/liblas/capi/liblas.h

@@ -520 +520 @@
  *  @param value integer value to set the minor version to (only the values 1 or 0 are valid)
  *  @return LASError enum
+ *
+ *  @todo TODO: Maybe this should return fatal error if version out of range -- hobu
 */
 LAS_DLL LASError LASHeader_SetVersionMinor(LASHeaderH hHeader, uint8_t value);

trunk/include/liblas/lasheader.hpp

@@ -58 +58 @@
 /// describing a family of ASPRS LAS files. The header is stored
 /// at the beginning of every valid ASPRS LAS file.
+///
+/// \todo  TODO (low-priority): replace static-size char arrays as data members
+///        with std::string and return const-reference to string object.
+///
 class LASHeader
 {
@@ -128 +132 @@
     /// \param v - should be set to a value between 1 and 65535.
     /// \exception No throw
+    ///
+    /// \todo TODO: Should we warn or throw about type overflow when user passes 65535 + 1 = 0
     void SetFileSourceId(uint16_t v);
 
     /// Get value field reserved by the ASPRS LAS Specification.
     /// \note This field is always filled with 0.
+    ///
+    /// \todo TODO: Should we warn or throw about type overflow when user passes 65535 + 1 = 0
     uint16_t GetReserved() const;
 
@@ -190 +198 @@
 
     /// Get day of year of file creation date.
-    /// \todo Use full date structure instead of Julian date number.
+    /// \todo TODO: Use full date structure instead of Julian date number.
     uint16_t GetCreationDOY() const;
 
     /// Set day of year of file creation date.
     /// \exception std::out_of_range - given value is higher than number 366.
-    /// \todo Use full date structure instead of Julian date number.
+    /// \todo TODO: Use full date structure instead of Julian date number.
     void SetCreationDOY(uint16_t v);
 
     /// Set year of file creation date.
-    /// \todo Remove if full date structure is used.
+    /// \todo TODO: Remove if full date structure is used.
     uint16_t GetCreationYear() const;
 
     /// Get year of file creation date.
     /// \exception std::out_of_range - given value is higher than number 9999.
-    /// \todo Remove if full date structure is used.
+    /// \todo TODO: Remove if full date structure is used.
     void SetCreationYear(uint16_t v);
 

trunk/include/liblas/laspoint.hpp

@@ -56 +56 @@
 ///
 /// \todo TODO: Think about last 1-byte field in record Point Source ID (LAS 1.1)
+///
 class LASPoint
 {
@@ -143 +144 @@
     double const& operator[](std::size_t const& n) const;
 
+    /// \todo TODO: Should we compare other data members, but not only coordinates?
     bool equal(LASPoint const& other) const;
 

trunk/include/liblas/lasreader.hpp

@@ -86 +86 @@
 
     void Init(); // throws on error
+
+    /// \todo TODO: Should we handle m_record.point_source_id ?
     void MakePoint(double const& time);
 

trunk/include/liblas/laswriter.hpp

@@ -65 +65 @@
     std::size_t GetVersion() const;
     LASHeader const& GetHeader() const;
+
+    /// \todo TODO: Move point record composition deep into writer implementation.
+    /// \todo TODO: How to handle point_source_id in portable way, for LAS 1.0 and 1.1
     bool WritePoint(LASPoint const& point);
 

trunk/src/lasreader.cpp

@@ -170 +170 @@
     m_point.SetUserData(m_record.user_data);
     
-    // TODO: Are we going to handle m_record.point_source_id ?
+    // TODO: Should we handle m_record.point_source_id ?
 
     m_point.SetTime(time);

trunk/src/laswriter.cpp

@@ -91 +91 @@
     m_record.scan_angle_rank = point.GetScanAngleRank();
     m_record.user_data = point.GetUserData();
-    m_record.point_source_id = 0; // TODO: How to handle this in portable way, for LAS 1.0 and 1.1
+    // TODO: How to handle this in portable way, for LAS 1.0 and 1.1
+    m_record.point_source_id = 0;