[fdo-commits] r731 - branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry
svn_fdo at osgeo.org
svn_fdo at osgeo.org
Wed Feb 7 16:26:45 EST 2007
Author: gregboone
Date: 2007-02-07 16:26:44 -0500 (Wed, 07 Feb 2007)
New Revision: 731
Modified:
branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgDirectPositionImpl.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgEnvelopeImpl.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgFgfGeometryFactory.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgGeometryFactoryAbstract.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIDirectPosition.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIDirectPositionImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIEnvelope.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIEnvelopeImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgILineStringImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgILinearRingImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIPointImp.h
Log:
893057: DOC: FDO Managed API Documentation Updates
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgDirectPositionImpl.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgDirectPositionImpl.h 2007-02-07 21:24:58 UTC (rev 730)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgDirectPositionImpl.h 2007-02-07 21:26:44 UTC (rev 731)
@@ -177,7 +177,7 @@
/// Gets the X ordinate.
///
/// \return
- /// Returns the X ordinate; default is numeric_limits<double>::quiet_NaN()
+ /// Returns the X ordinate; default is numeric_limits::quiet_NaN()
///
__property System::Double get_X();
@@ -196,7 +196,7 @@
/// Gets the Y ordinate.
///
/// \return
- /// Returns the Y ordinate; default is numeric_limits<double>::quiet_NaN()
+ /// Returns the Y ordinate; default is numeric_limits::quiet_NaN()
///
__property System::Double get_Y();
@@ -215,14 +215,14 @@
/// Gets the Z ordinate.
///
/// \return
- /// Returns the Z ordinate; default is numeric_limits<double>::quiet_NaN()
+ /// Returns the Z ordinate; default is numeric_limits::quiet_NaN()
///
__property System::Double get_Z();
/// \brief
/// Sets the Z ordinate.
///
- /// \param z
+ /// \param value
/// Input Z ordinate value
///
/// \return
@@ -234,7 +234,7 @@
/// Gets the M ordinate.
///
/// \return
- /// Returns the M ordinate; default is numeric_limits<double>::quiet_NaN()
+ /// Returns the M ordinate; default is numeric_limits::quiet_NaN()
///
__property System::Double get_M();
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgEnvelopeImpl.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgEnvelopeImpl.h 2007-02-07 21:24:58 UTC (rev 730)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgEnvelopeImpl.h 2007-02-07 21:26:44 UTC (rev 731)
@@ -38,28 +38,11 @@
{
public:
/// \brief
- /// InEquality function for EnvelopeImpl.
- ///
- /// \param right
- /// Input envelope for comparison (right-hand-side of equation)
- ///
- /// \param left
- /// Input envelope for comparison (left-hand-side of equation)
- ///
- /// \return
- /// Returns true if the envelope ordinates are not equal.
- ///
- static System::Boolean op_Inequality(EnvelopeImpl *left, EnvelopeImpl* right);
-
- /// \brief
/// Constructs a default instance of a EnvelopeImpl object.
///
/// \remarks
/// Ordinate values default to System::Double::NaN.
///
- /// \return
- /// Returns nothing
- ///
EnvelopeImpl();
/// \brief
@@ -77,9 +60,6 @@
/// \param maxY
/// Input Upper-right Y ordinate
///
- /// \return
- /// Returns nothing
- ///
EnvelopeImpl(System::Double minX, System::Double minY,
System::Double maxX, System::Double maxY);
@@ -99,9 +79,6 @@
/// \param maxZ
/// Input Upper-right, front Z ordinate
///
- /// \return
- /// Returns nothing
- ///
EnvelopeImpl(System::Double minX, System::Double minY, System::Double minZ,
System::Double maxX, System::Double maxY, System::Double maxZ);
@@ -111,9 +88,6 @@
/// \param envelopeImpl
/// Input envelope to copy
///
- /// \return
- /// Returns nothing
- ///
EnvelopeImpl(EnvelopeImpl* envelopeImpl);
/// \brief
@@ -124,9 +98,6 @@
/// \param upperRight
/// Input Upper-right position
///
- /// \return
- /// Returns nothing
- ///
EnvelopeImpl(NAMESPACE_OSGEO_GEOMETRY::IDirectPosition* lowerLeft, NAMESPACE_OSGEO_GEOMETRY::IDirectPosition * upperRight);
/// \brief
@@ -137,9 +108,6 @@
/// \param ordinates
/// Input ordinate array representing two positions
///
- /// \return
- /// Returns nothing
- ///
EnvelopeImpl(System::Int32 dimensionType, System::Double ordinates __gc[]);
/// \brief
@@ -157,6 +125,20 @@
static System::Boolean op_Equality(EnvelopeImpl *left, EnvelopeImpl* right);
/// \brief
+ /// InEquality function for EnvelopeImpl.
+ ///
+ /// \param right
+ /// Input envelope for comparison (right-hand-side of equation)
+ ///
+ /// \param left
+ /// Input envelope for comparison (left-hand-side of equation)
+ ///
+ /// \return
+ /// Returns true if the envelope ordinates are not equal.
+ ///
+ static System::Boolean op_Inequality(EnvelopeImpl *left, EnvelopeImpl* right);
+
+ /// \brief
/// Equality function for EnvelopeImpl.
///
/// \param obj
@@ -175,7 +157,7 @@
/// Gets the minimum X coordinate value.
///
/// \return
- /// Returns the minimum X ordinate; numeric_limits<double>::quiet_NaN() by default
+ /// Returns the minimum X ordinate; numeric_limits::quiet_NaN() by default
///
__property System::Double get_MinX();
@@ -194,7 +176,7 @@
/// Gets the minimum Y coordinate value.
///
/// \return
- /// Returns the minimum Y ordinate; numeric_limits<double>::quiet_NaN() by default
+ /// Returns the minimum Y ordinate; numeric_limits::quiet_NaN() by default
///
__property System::Double get_MinY();
@@ -213,7 +195,7 @@
/// Gets the minimum Z coordinate value.
///
/// \return
- /// Returns the minimum Z ordinate; numeric_limits<double>::quiet_NaN() by default
+ /// Returns the minimum Z ordinate; numeric_limits::quiet_NaN() by default
///
__property System::Double get_MinZ();
@@ -232,7 +214,7 @@
/// Gets the maximum X coordinate value.
///
/// \return
- /// Returns the maximum X ordinate; numeric_limits<double>::quiet_NaN() by default
+ /// Returns the maximum X ordinate; numeric_limits::quiet_NaN() by default
///
__property System::Double get_MaxX();
@@ -251,7 +233,7 @@
/// Gets the maximum Y coordinate value.
///
/// \return
- /// Returns the maximum Y ordinate; numeric_limits<double>::quiet_NaN() by default
+ /// Returns the maximum Y ordinate; numeric_limits::quiet_NaN() by default
///
__property System::Double get_MaxY();
@@ -270,7 +252,7 @@
/// Gets the maximum Z coordinate value.
///
/// \return
- /// Returns the maximum Z ordinate; numeric_limits<double>::quiet_NaN() by default
+ /// Returns the maximum Z ordinate; numeric_limits::quiet_NaN() by default
///
__property System::Double get_MaxZ();
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgFgfGeometryFactory.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgFgfGeometryFactory.h 2007-02-07 21:24:58 UTC (rev 730)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgFgfGeometryFactory.h 2007-02-07 21:26:44 UTC (rev 731)
@@ -125,7 +125,7 @@
/// \brief
/// Creates an FGF-based Geometry from OpenGIS WKB data.
///
- /// \param byteArray
+ /// \param bytes
/// Input WKB data that defines the Geometry.
///
/// \return
@@ -306,7 +306,7 @@
/// \brief
/// Creates a LineStringSegment object by copying from an array of ordinates.
///
- /// \param dimtype
+ /// \param dimType
/// Input dimensionality of the ordinates (see Dimensionality)
/// \param ordinateNumber
/// Input total number of ordinates in the array
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgGeometryFactoryAbstract.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgGeometryFactoryAbstract.h 2007-02-07 21:24:58 UTC (rev 730)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgGeometryFactoryAbstract.h 2007-02-07 21:26:44 UTC (rev 731)
@@ -409,7 +409,7 @@
/// \brief
/// Creates a LineStringSegment object by copying from an array of ordinates.
///
- /// \param dimtype
+ /// \param dimType
/// Input dimensionality of the ordinates (see Dimensionality)
/// \param ordinateNumber
/// Input total number of ordinates in the array
@@ -505,7 +505,7 @@
///
/// \param startPosition
/// Input starting position of the arc
- /// \param coordinateMidPosition
+ /// \param midPosition
/// Input a position on the arc, and not equal to the starting or ending positions
/// \param endPosition
/// Input ending position of the arc
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIDirectPosition.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIDirectPosition.h 2007-02-07 21:24:58 UTC (rev 730)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIDirectPosition.h 2007-02-07 21:26:44 UTC (rev 731)
@@ -37,7 +37,7 @@
/// Gets the X ordinate.
///
/// \return
- /// Returns the X ordinate; default is numeric_limits<double>::quiet_NaN()
+ /// Returns the X ordinate; default is numeric_limits::quiet_NaN()
///
__property System::Double get_X();
@@ -45,7 +45,7 @@
/// Gets the Y ordinate.
///
/// \return
- /// Returns the Y ordinate; default is numeric_limits<double>::quiet_NaN()
+ /// Returns the Y ordinate; default is numeric_limits::quiet_NaN()
///
__property System::Double get_Y();
@@ -53,7 +53,7 @@
/// Gets the Z ordinate.
///
/// \return
- /// Returns the Z ordinate; default is numeric_limits<double>::quiet_NaN()
+ /// Returns the Z ordinate; default is numeric_limits::quiet_NaN()
///
__property System::Double get_Z();
@@ -61,7 +61,7 @@
/// Gets the M ordinate.
///
/// \return
- /// Returns the M ordinate; default is numeric_limits<double>::quiet_NaN()
+ /// Returns the M ordinate; default is numeric_limits::quiet_NaN()
///
__property System::Double get_M();
@@ -87,6 +87,14 @@
{
public:
/// \brief
+ /// Creates an instance of DirectPositionCollection with no contained elements.
+ ///
+ /// \return
+ /// Returns an empty collection
+ ///
+ DirectPositionCollection();
+
+ /// \brief
/// Constructs a DirectPositionCollection managed object based on an unmanaged instance of the object
///
/// \param unmanaged
@@ -98,10 +106,10 @@
///
DirectPositionCollection(System::IntPtr unmanaged, System::Boolean autoDelete);
+/// \cond DOXYGEN-IGNORE
public private:
FdoDirectPositionCollection *GetImpObj();
-/// \cond DOXYGEN-IGNORE
protected:
__sealed System::Void ReleaseUnmanagedObject();
@@ -175,14 +183,6 @@
///
System::Void Reset();
};
-public:
- /// \brief
- /// Creates an instance of DirectPositionCollection with no contained elements.
- ///
- /// \return
- /// Returns an empty collection
- ///
- DirectPositionCollection();
private:
// System::Collections::ICollection interface properties
@@ -205,6 +205,8 @@
System::Void System::Collections::IList::Insert(System::Int32 index, Object* value);
System::Void System::Collections::IList::Remove(Object* value);
+/// \endcond
+
public:
/// \brief
/// Gets the count of items in collection.
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIDirectPositionImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIDirectPositionImp.h 2007-02-07 21:24:58 UTC (rev 730)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIDirectPositionImp.h 2007-02-07 21:26:44 UTC (rev 731)
@@ -58,7 +58,7 @@
/// Gets the X ordinate.
///
/// \return
- /// Returns the X ordinate; default is numeric_limits<double>::quiet_NaN()
+ /// Returns the X ordinate; default is numeric_limits::quiet_NaN()
///
__property System::Double get_X();
@@ -66,7 +66,7 @@
/// Gets the Y ordinate.
///
/// \return
- /// Returns the Y ordinate; default is numeric_limits<double>::quiet_NaN()
+ /// Returns the Y ordinate; default is numeric_limits::quiet_NaN()
///
__property System::Double get_Y();
@@ -74,7 +74,7 @@
/// Gets the Z ordinate.
///
/// \return
- /// Returns the Z ordinate; default is numeric_limits<double>::quiet_NaN()
+ /// Returns the Z ordinate; default is numeric_limits::quiet_NaN()
///
__property System::Double get_Z();
@@ -82,7 +82,7 @@
/// Gets the M ordinate.
///
/// \return
- /// Returns the M ordinate; default is numeric_limits<double>::quiet_NaN()
+ /// Returns the M ordinate; default is numeric_limits::quiet_NaN()
///
__property System::Double get_M();
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIEnvelope.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIEnvelope.h 2007-02-07 21:24:58 UTC (rev 730)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIEnvelope.h 2007-02-07 21:26:44 UTC (rev 731)
@@ -28,7 +28,7 @@
/// known in 2 dimensions as an MBR ("Minimum Bounding Rectangle").
/// The box may be initially empty, meaning that no dimensions have an assigned value.
/// Each individual extent may be unassigned, in which case using its
-/// accessor will return numeric_limits<double>::quiet_NaN().
+/// accessor will return numeric_limits::quiet_NaN().
public __gc __interface IEnvelope : public System::IDisposable
{
public:
@@ -42,7 +42,7 @@
/// corner of the envelope.
///
/// \return
- /// Returns the miniumum X ordinate; numeric_limits<double>::quiet_NaN() by default
+ /// Returns the miniumum X ordinate; numeric_limits::quiet_NaN() by default
///
__property System::Double get_MinX();
@@ -56,7 +56,7 @@
/// corner of the envelope.
///
/// \return
- /// Returns the miniumum Y ordinate; numeric_limits<double>::quiet_NaN() by default
+ /// Returns the miniumum Y ordinate; numeric_limits::quiet_NaN() by default
///
__property System::Double get_MinY();
@@ -70,7 +70,7 @@
/// corner of the envelope.
///
/// \return
- /// Returns the miniumum Z ordinate; numeric_limits<double>::quiet_NaN() by default
+ /// Returns the miniumum Z ordinate; numeric_limits::quiet_NaN() by default
///
__property System::Double get_MinZ();
@@ -84,7 +84,7 @@
/// corner of the envelope.
///
/// \return
- /// Returns the maxiumum X ordinate; numeric_limits<double>::quiet_NaN() by default
+ /// Returns the maxiumum X ordinate; numeric_limits::quiet_NaN() by default
///
__property System::Double get_MaxX();
@@ -98,7 +98,7 @@
/// corner of the envelope.
///
/// \return
- /// Returns the maxiumum Y ordinate; numeric_limits<double>::quiet_NaN() by default
+ /// Returns the maxiumum Y ordinate; numeric_limits::quiet_NaN() by default
///
__property System::Double get_MaxY();
@@ -112,7 +112,7 @@
/// corner of the envelope.
///
/// \return
- /// Returns the maxiumum Z ordinate; numeric_limits<double>::quiet_NaN() by default
+ /// Returns the maxiumum Z ordinate; numeric_limits::quiet_NaN() by default
///
__property System::Double get_MaxZ();
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIEnvelopeImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIEnvelopeImp.h 2007-02-07 21:24:58 UTC (rev 730)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIEnvelopeImp.h 2007-02-07 21:26:44 UTC (rev 731)
@@ -28,12 +28,12 @@
/// The IEnvelopeImp class is a three-dimensional, axis-aligned box. This is a
/// helper type for Geometries, and does not itself inherit from
/// IGeometry.
+/// \remarks
/// This type is typically used to record the "extents" of a shape, also
/// known in 2 dimensions as an MBR ("Minimum Bounding Rectangle").
/// The box may be initially empty, meaning that no dimensions have an
-/// assigned value.
-/// each individual extent may be unassigned, in which case using its
-/// accessor will return numeric_limits<double>::quiet_NaN().
+/// assigned value. Each individual extent may be unassigned, in which case using its
+/// accessor will return numeric_limits::quiet_NaN().
public __gc class IEnvelopeImp : public NAMESPACE_OSGEO_RUNTIME::Disposable, public NAMESPACE_OSGEO_GEOMETRY::IEnvelope
{
public:
@@ -65,7 +65,7 @@
/// corner of the envelope.
///
/// \return
- /// Returns the miniumum X ordinate; numeric_limits<double>::quiet_NaN() by default
+ /// Returns the miniumum X ordinate; numeric_limits::quiet_NaN() by default
///
__property System::Double get_MinX();
@@ -79,7 +79,7 @@
/// corner of the envelope.
///
/// \return
- /// Returns the miniumum Y ordinate; numeric_limits<double>::quiet_NaN() by default
+ /// Returns the miniumum Y ordinate; numeric_limits::quiet_NaN() by default
///
__property System::Double get_MinY();
@@ -93,7 +93,7 @@
/// corner of the envelope.
///
/// \return
- /// Returns the miniumum Z ordinate; numeric_limits<double>::quiet_NaN() by default
+ /// Returns the miniumum Z ordinate; numeric_limits::quiet_NaN() by default
///
__property System::Double get_MinZ();
@@ -107,7 +107,7 @@
/// corner of the envelope.
///
/// \return
- /// Returns the maxiumum X ordinate; numeric_limits<double>::quiet_NaN() by default
+ /// Returns the maxiumum X ordinate; numeric_limits::quiet_NaN() by default
///
__property System::Double get_MaxX();
@@ -121,7 +121,7 @@
/// corner of the envelope.
///
/// \return
- /// Returns the maxiumum Y ordinate; numeric_limits<double>::quiet_NaN() by default
+ /// Returns the maxiumum Y ordinate; numeric_limits::quiet_NaN() by default
///
__property System::Double get_MaxY();
@@ -135,7 +135,7 @@
/// corner of the envelope.
///
/// \return
- /// Returns the maxiumum Z ordinate; numeric_limits<double>::quiet_NaN() by default
+ /// Returns the maxiumum Z ordinate; numeric_limits::quiet_NaN() by default
///
__property System::Double get_MaxZ();
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgILineStringImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgILineStringImp.h 2007-02-07 21:24:58 UTC (rev 730)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgILineStringImp.h 2007-02-07 21:26:44 UTC (rev 731)
@@ -81,13 +81,13 @@
///
/// \param index
/// Input Zero-based index in the object's list of positions.
- /// \param x
+ /// \param coordinateX
/// Output X ordinate value.
- /// \param y
+ /// \param coordinateY
/// Output Y ordinate value.
- /// \param z
+ /// \param coordinateZ
/// Output Z ordinate value.
- /// \param m
+ /// \param coordinateM
/// Output M ordinate value.
/// \param dimensionality
/// Output Dimensionality of ordinates in this position.
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgILinearRingImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgILinearRingImp.h 2007-02-07 21:24:58 UTC (rev 730)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgILinearRingImp.h 2007-02-07 21:26:44 UTC (rev 731)
@@ -81,13 +81,13 @@
///
/// \param index
/// Input Zero-based index in the object's list of positions.
- /// \param x
+ /// \param coordinateX
/// Output X ordinate value.
- /// \param y
+ /// \param coordinateY
/// Output Y ordinate value.
- /// \param z
+ /// \param coordinateZ
/// Output Z ordinate value.
- /// \param m
+ /// \param coordinateM
/// Output M ordinate value.
/// \param dimensionality
/// Output Dimensionality of ordinates in this position.
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIPointImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIPointImp.h 2007-02-07 21:24:58 UTC (rev 730)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIPointImp.h 2007-02-07 21:26:44 UTC (rev 731)
@@ -65,13 +65,13 @@
/// does not internally use FdoIDirectPosition objects for storage, or for
/// an application seeking to avoid overhead of accessor methods.
///
- /// \param x
+ /// \param coordinateX
/// Output X ordinate value.
- /// \param y
+ /// \param coordinateY
/// Output Y ordinate value.
- /// \param z
+ /// \param coordinateZ
/// Output Z ordinate value.
- /// \param m
+ /// \param coordinateM
/// Output M ordinate value.
/// \param dimensionality
/// Output Dimensionality of ordinates in this position.
More information about the fdo-commits
mailing list