[fdo-commits] r2531 - in trunk/Fdo/Managed/Src/OSGeo/Common: . Xml
svn_fdo at osgeo.org
svn_fdo at osgeo.org
Thu Feb 15 15:09:11 EST 2007
Author: gregboone
Date: 2007-02-15 15:09:10 -0500 (Thu, 15 Feb 2007)
New Revision: 2531
Modified:
trunk/Fdo/Managed/Src/OSGeo/Common/Xml/mgIXmlSaxHandler.h
trunk/Fdo/Managed/Src/OSGeo/Common/mgGeometryType.h
trunk/Fdo/Managed/Src/OSGeo/Common/mgIStreamReader.h
Log:
FDO4: API - Update API documentation included in the FDO header files
Modified: trunk/Fdo/Managed/Src/OSGeo/Common/Xml/mgIXmlSaxHandler.h
===================================================================
--- trunk/Fdo/Managed/Src/OSGeo/Common/Xml/mgIXmlSaxHandler.h 2007-02-15 20:03:41 UTC (rev 2530)
+++ trunk/Fdo/Managed/Src/OSGeo/Common/Xml/mgIXmlSaxHandler.h 2007-02-15 20:09:10 UTC (rev 2531)
@@ -22,6 +22,8 @@
public __gc class XmlAttributeCollection;
public __gc class XmlSaxContext;
+/// \ingroup (interfaces)
+/// \interface IXmlSaxHandler
/// \brief
/// IXmlSaxHandler defines the SAX Handler callback interface.
/// It is not an interface in the strict sense, since each function has a
Modified: trunk/Fdo/Managed/Src/OSGeo/Common/mgGeometryType.h
===================================================================
--- trunk/Fdo/Managed/Src/OSGeo/Common/mgGeometryType.h 2007-02-15 20:03:41 UTC (rev 2530)
+++ trunk/Fdo/Managed/Src/OSGeo/Common/mgGeometryType.h 2007-02-15 20:09:10 UTC (rev 2531)
@@ -20,83 +20,67 @@
BEGIN_NAMESPACE_OSGEO_COMMON
+/// \ingroup (enums)
/// \brief
-/// GeometryType is an enumeration to denote the type of a Geometry.
+/// GeometryType is an enumeration to denote the type of a Geometry.
/// \remarks
-/// This enumeration applies to types that derive from IGeometry.
-/// <param name="GeometryType_None">
-/// Indicates no specific type; used for "unknown", "don't care" or an incompletely constructed Geometry object.
-/// </param>
-/// <param name="GeometryType_Point">
-/// Point type
-/// </param>
-/// <param name="GeometryType_LineString">
-/// LineString type
-/// </param>
-/// <param name="GeometryType_Polygon">
-/// Polygon type
-/// </param>
-/// <param name="GeometryType_MultiPoint">
-/// MultiPoint type
-/// </param>
-/// <param name="GeometryType_MultiLineString">
-/// MultiLineString type
-/// </param>
-/// <param name="GeometryType_MultiPolygon">
-/// MultiPolygon type
-/// </param>
-/// <param name="GeometryType_MultiGeometry">
-/// MultiGeometry type
-/// </param>
-/// <param name="GeometryType_CurveString">
-/// CurveString type
-/// </param>
-/// <param name="GeometryType_CurvePolygon">
-/// CurvePolygon type
-/// </param>
-/// <param name="GeometryType_MultiCurveString">
-/// MultiCurveString type
-/// </param>
-/// <param name="GeometryType_MultiCurvePolygon">
-/// MultiCurvePolygon type
-/// </param>
+/// This enumeration applies to types that derive from IGeometry.
public __value enum GeometryType
{
+ /// Indicates no specific type; used for "unknown", "don't care" or an incompletely constructed Geometry object.
GeometryType_None = FdoGeometryType_None,
+
+ /// Point type
GeometryType_Point = FdoGeometryType_Point,
+
+ /// LineString type
GeometryType_LineString = FdoGeometryType_LineString,
+
+ /// Polygon type
GeometryType_Polygon = FdoGeometryType_Polygon,
+
+ /// MultiPoint type
GeometryType_MultiPoint = FdoGeometryType_MultiPoint,
+
+ /// MultiLineString type
GeometryType_MultiLineString = FdoGeometryType_MultiLineString,
+
+ /// MultiPolygon type
GeometryType_MultiPolygon = FdoGeometryType_MultiPolygon,
+
+ /// MultiGeometry type
GeometryType_MultiGeometry = FdoGeometryType_MultiGeometry,
+
+ /// CurveString type
GeometryType_CurveString = FdoGeometryType_CurveString,
+
+ /// CurvePolygon type
GeometryType_CurvePolygon = FdoGeometryType_CurvePolygon,
+
+ /// MultiCurveString type
GeometryType_MultiCurveString = FdoGeometryType_MultiCurveString,
+
+ /// MultiCurvePolygon type
GeometryType_MultiCurvePolygon = FdoGeometryType_MultiCurvePolygon
};
+/// \ingroup (enums)
/// \brief
-/// Enumeration for components of Geometry.
+/// Enumeration for components of Geometry.
/// \remarks
-/// This enumeration applies to certain helper types that are used to compose other types which derive from IGeometry.
-/// <param name="GeometryComponentType_LinearRing">
-/// LinearRing type
-/// </param>
-/// <param name="GeometryComponentType_CircularArcSegment">
-/// CircularArcSegment type
-/// </param>
-/// <param name="GeometryComponentType_LineStringSegment">
-/// LineStringSegment type
-/// </param>
-/// <param name="GeometryComponentType_Ring">
-/// Ring type
-/// </param>
+/// This enumeration applies to certain helper types that are used to compose other types which derive from IGeometry.
public __value enum GeometryComponentType
{
+ /// LinearRing type
GeometryComponentType_LinearRing = FdoGeometryComponentType_LinearRing,
+
+ /// CircularArcSegment type
GeometryComponentType_CircularArcSegment = FdoGeometryComponentType_CircularArcSegment,
+
+ /// LineStringSegment type
GeometryComponentType_LineStringSegment = FdoGeometryComponentType_LineStringSegment,
+
+ /// Ring type
GeometryComponentType_Ring = FdoGeometryComponentType_Ring
};
Modified: trunk/Fdo/Managed/Src/OSGeo/Common/mgIStreamReader.h
===================================================================
--- trunk/Fdo/Managed/Src/OSGeo/Common/mgIStreamReader.h 2007-02-15 20:03:41 UTC (rev 2530)
+++ trunk/Fdo/Managed/Src/OSGeo/Common/mgIStreamReader.h 2007-02-15 20:09:10 UTC (rev 2531)
@@ -22,14 +22,20 @@
BEGIN_NAMESPACE_OSGEO_COMMON
+/// \ingroup (enums)
/// \brief
/// Enumeration for datatypes used by stream readers.
public __value enum StreamReaderType
{
+ /// Byte Stream Reader type
StreamReaderType_Byte = FdoStreamReaderType_Byte,
+
+ /// Char Stream Reader type
StreamReaderType_Char = FdoStreamReaderType_Char,
};
+/// \ingroup (interfaces)
+/// \interface IStreamReader
/// \brief
/// The IStreamReader class is a top level interface for stream reader classes.
/// The API it provides allows the user to read large streams of data in blocks of items.
More information about the fdo-commits
mailing list