[fdo-commits] r2528 - trunk/Fdo/Unmanaged/Inc/Fdo/Raster

[svn_fdo at osgeo.org]

Author: gregboone
Date: 2007-02-15 14:58:44 -0500 (Thu, 15 Feb 2007)
New Revision: 2528

Modified:
   trunk/Fdo/Unmanaged/Inc/Fdo/Raster/RasterDataModel.h
   trunk/Fdo/Unmanaged/Inc/Fdo/Raster/RasterDataModelType.h
   trunk/Fdo/Unmanaged/Inc/Fdo/Raster/RasterDataOrganization.h
   trunk/Fdo/Unmanaged/Inc/Fdo/Raster/RasterDataType.h
Log:
FDO4: API - Update API documentation included in the FDO header files

Modified: trunk/Fdo/Unmanaged/Inc/Fdo/Raster/RasterDataModel.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/Raster/RasterDataModel.h	2007-02-15 19:58:18 UTC (rev 2527)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/Raster/RasterDataModel.h	2007-02-15 19:58:44 UTC (rev 2528)
@@ -155,7 +155,7 @@
     /// \brief
     /// Sets the data type.
     /// 
-    /// \param value 
+    /// \param dataType
     /// Specifies the data type the raster data is to be returned in.
     /// 
     FDO_API virtual void SetDataType (FdoRasterDataType dataType);
@@ -163,7 +163,7 @@
     /// \brief
     /// Compares this raster data model with another one.
     /// 
-    /// \param value 
+    /// \param pModel
     /// The Raster Data Model to compare with
     /// 
     /// \return

Modified: trunk/Fdo/Unmanaged/Inc/Fdo/Raster/RasterDataModelType.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/Raster/RasterDataModelType.h	2007-02-15 19:58:18 UTC (rev 2527)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/Raster/RasterDataModelType.h	2007-02-15 19:58:44 UTC (rev 2528)
@@ -23,6 +23,7 @@
 
 #include <FdoStd.h>
 
+/// \ingroup (enums)
 /// \brief
 /// The FdoRasterDataModelType enumeration specifies the type of
 /// data within each pixel. In all cases the data is 'packed', that is,
@@ -38,28 +39,6 @@
 /// allocated to each band, so for example RGBT data with eight bits for red,
 /// would also have eight bits for each of the three other bands totaling
 /// thirty-two bits (BitsPerPixel=32).
-/// <param name="FdoRasterDataModelType_Unknown">
-/// Data is organized in an unknown or provider specific manner.
-/// </param>
-/// <param name="FdoRasterDataModelType_Bitonal">
-/// Data is organized as one bit (black/white - bitonal) data.
-/// </param>
-/// <param name="FdoRasterDataModelType_Gray">
-/// Data is monochrome (black->gray->white) pixels.
-/// It is necessary to know the BitsPerPixel value to interpret the data.
-/// </param>
-/// <param name="FdoRasterDataModelType_RGB">
-/// Data is red/green/blue (in that order) pixels.
-/// It is necessary to know the BitsPerPixel value to interpret the data.
-/// </param>
-/// <param name="FdoRasterDataModelType_RGBA">
-/// Data is red/green/blue/alpha (in that order) pixels; RGB with transparency.
-/// It is necessary to know the BitsPerPixel value to interpret the data.
-/// </param>
-/// <param name="FdoRasterDataModelType_Palette">
-/// Data is monochrome but backed by a pallette (value->pallette->colour) pixels.
-/// It is necessary to know the BitsPerPixel value to interpret the data.
-/// </param>
 enum FdoRasterDataModelType
 {
     /// Data is organized in an unknown or provider specific manner.

Modified: trunk/Fdo/Unmanaged/Inc/Fdo/Raster/RasterDataOrganization.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/Raster/RasterDataOrganization.h	2007-02-15 19:58:18 UTC (rev 2527)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/Raster/RasterDataOrganization.h	2007-02-15 19:58:44 UTC (rev 2528)
@@ -23,6 +23,7 @@
 
 #include <FdoStd.h>
 
+/// \ingroup (enums)
 /// \brief
 /// The FdoRasterDataOrganization enumeration specifies the way
 /// pixel data is interleaved. Data is stored/retrieved in left to right,
@@ -35,15 +36,7 @@
 /// followed by the same number of green bytes, followed by the same
 /// number of blue bytes. This organization dependant storage should be
 /// considered when 'skipping' to the middle of an image.
-/// <param name="FdoRasterDataOrganization_Pixel">
-/// Data is interleaved by pixel, with all data for a pixel contiguous in memory.
 /// </param>
-/// <param name="FdoRasterDataOrganization_Row">
-/// Data is interleaved by row, with all data of a channel for one row contiguous in memory, followed by a rows worth of the next channel, etc.
-/// </param>
-/// <param name="FdoRasterDataOrganization_Image">
-/// Data is interleaved by image, with all data of a channel for a complete image contiguous in memory, followed by a complete image of the next channel, etc.
-/// </param>
 enum FdoRasterDataOrganization
 {
 

Modified: trunk/Fdo/Unmanaged/Inc/Fdo/Raster/RasterDataType.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/Raster/RasterDataType.h	2007-02-15 19:58:18 UTC (rev 2527)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/Raster/RasterDataType.h	2007-02-15 19:58:44 UTC (rev 2528)
@@ -23,33 +23,24 @@
 
 #include <FdoStd.h>
 
+/// \ingroup (enums)
 /// \brief
 /// The FdoRasterDataType enumeration specifies the type of data stored in the Raster Image.
-/// <param name="FdoRasterDataType_Unknown">
-/// Data is organized in an unknown or provider specific manner.
-/// </param>
-/// <param name="FdoRasterDataType_UnsignedInteger">
-/// Data is organized as Unsigned Integers.
-/// </param>
-/// <param name="FdoRasterDataType_Integer">
-/// Data is organized as Signed Integers.
-/// </param>
-/// <param name="FdoRasterDataType_Float">
-/// Data is organized as Floats.
-/// </param>
-/// <param name="FdoRasterDataType_Double">
-/// Data is organized as Doubles.
-/// </param>
 enum FdoRasterDataType
 {
+    /// Data is organized in an unknown or provider specific manner.
     FdoRasterDataType_Unknown,
 
+    /// Data is organized as Unsigned Integers.
     FdoRasterDataType_UnsignedInteger,
 
+    /// Data is organized as Signed Integers.
     FdoRasterDataType_Integer,
 
+    /// Data is organized as Floats.
     FdoRasterDataType_Float,
 
+    /// Data is organized as Doubles.
     FdoRasterDataType_Double
 };