[mapguide-commits] r8161 - in trunk/MgDev/Common: Foundation/Data Geometry/CoordinateSystem MapGuideCommon/Services PlatformBase/Services
svn_mapguide at osgeo.org
svn_mapguide at osgeo.org
Mon May 26 07:19:31 PDT 2014
Author: jng
Date: 2014-05-26 07:19:31 -0700 (Mon, 26 May 2014)
New Revision: 8161
Modified:
trunk/MgDev/Common/Foundation/Data/FeaturePropertyType.h
trunk/MgDev/Common/Foundation/Data/MimeType.h
trunk/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemErrorCode.h
trunk/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemGeodeticTransformationMethod.h
trunk/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemGridOrientation.h
trunk/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemGridSpecializationType.h
trunk/MgDev/Common/MapGuideCommon/Services/ImageFormats.h
trunk/MgDev/Common/MapGuideCommon/Services/MappingDefs.h
trunk/MgDev/Common/MapGuideCommon/Services/UnitType.h
trunk/MgDev/Common/PlatformBase/Services/BaseServiceDefs.h
trunk/MgDev/Common/PlatformBase/Services/FeatureCommandType.h
trunk/MgDev/Common/PlatformBase/Services/FeatureGeometricType.h
trunk/MgDev/Common/PlatformBase/Services/FeatureService.h
trunk/MgDev/Common/PlatformBase/Services/ObjectPropertyType.h
trunk/MgDev/Common/PlatformBase/Services/RasterTypes.h
trunk/MgDev/Common/PlatformBase/Services/ReaderType.h
trunk/MgDev/Common/PlatformBase/Services/ResourceDefs.h
trunk/MgDev/Common/PlatformBase/Services/SpatialContextExtentType.h
Log:
API documentation updates
- Fill in more missing commentary
- #2452: Fix improperly formatted API documentation for certain constant classes
Modified: trunk/MgDev/Common/Foundation/Data/FeaturePropertyType.h
===================================================================
--- trunk/MgDev/Common/Foundation/Data/FeaturePropertyType.h 2014-05-26 14:17:09 UTC (rev 8160)
+++ trunk/MgDev/Common/Foundation/Data/FeaturePropertyType.h 2014-05-26 14:19:31 UTC (rev 8161)
@@ -59,6 +59,7 @@
static const int AssociationProperty = 103;
///////////////////////////////////////////////////
+ /// \brief
/// Type name for a raster property definition. See
/// MgRasterPropertyDefinition.
static const int RasterProperty = 104;
Modified: trunk/MgDev/Common/Foundation/Data/MimeType.h
===================================================================
--- trunk/MgDev/Common/Foundation/Data/MimeType.h 2014-05-26 14:17:09 UTC (rev 8160)
+++ trunk/MgDev/Common/Foundation/Data/MimeType.h 2014-05-26 14:19:31 UTC (rev 8161)
@@ -32,42 +32,55 @@
/// The "value(xxx)" comments are used by SWIG to build constants.php. Do not alter them.
/// \endif
+ /// \brief
/// application/agf
static const STRING Agf; ///\if INTERNAL value("application/agf") \endif
+ /// \brief
/// application/octet-stream
static const STRING Binary; ///\if INTERNAL value("application/octet-stream") \endif
+ /// \brief
/// model/vnd.dwf
static const STRING Dwf; ///\if INTERNAL value("model/vnd.dwf") \endif
+ /// \brief
/// image/gif
static const STRING Gif; ///\if INTERNAL value("image/gif") \endif
+ /// \brief
/// image/jpeg
static const STRING Jpeg; ///\if INTERNAL value("image/jpeg") \endif
+ /// \brief
/// image/png
static const STRING Png; ///\if INTERNAL value("image/png") \endif
+ /// \brief
/// text/plain
static const STRING Text; ///\if INTERNAL value("text/plain") \endif
+ /// \brief
/// image/tiff
static const STRING Tiff; ///\if INTERNAL value("image/tiff") \endif
+ /// \brief
/// text/xml
static const STRING Xml; ///\if INTERNAL value("text/xml") \endif
+ /// \brief
/// application/json
static const STRING Json; ///\if INTERNAL value("application/json") \endif
+ /// \brief
/// text/html
static const STRING Html; ///\if INTERNAL value("text/html") \endif
+ /// \brief
/// application/vnd.google-earth.kml+xml
static const STRING Kml; ///\if INTERNAL value("application/vnd.google-earth.kml+xml") \endif
+ /// \brief
/// application/vnd.google-earth.kmz
static const STRING Kmz; ///\if INTERNAL value("application/vnd.google-earth.kmz") \endif
};
Modified: trunk/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemErrorCode.h
===================================================================
--- trunk/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemErrorCode.h 2014-05-26 14:17:09 UTC (rev 8160)
+++ trunk/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemErrorCode.h 2014-05-26 14:19:31 UTC (rev 8161)
@@ -317,32 +317,32 @@
///////////////////////////////////////////////////////////////////////////////////////////////
/// \brief
- ///
+ /// The operation succeeded
///
static const INT32 Ok = 1000;
///////////////////////////////////////////////////////////////////////////////////////////////
/// \brief
- ///
+ /// The operation ran out of memory
///
static const INT32 OutOfMemory = 1001;
///////////////////////////////////////////////////////////////////////////////////////////////
/// \brief
- ///
+ /// An initialization operation failed
///
static const INT32 InitializationFailed = 1002;
///////////////////////////////////////////////////////////////////////////////////////////////
/// \brief
- ///
+ /// A conversion operation failed
///
static const INT32 ConversionFailed = 1003;
///////////////////////////////////////////////////////////////////////////////////////////////
/// \brief
- ///
+ /// An argument supplied to an operation was null
///
static const INT32 NullArgument = 1004;
///////////////////////////////////////////////////////////////////////////////////////////////
/// \brief
- ///
+ /// An argument supplied to an operation was invalid
///
static const INT32 InvalidArgument = 1005;
};
Modified: trunk/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemGeodeticTransformationMethod.h
===================================================================
--- trunk/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemGeodeticTransformationMethod.h 2014-05-26 14:17:09 UTC (rev 8160)
+++ trunk/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemGeodeticTransformationMethod.h 2014-05-26 14:19:31 UTC (rev 8161)
@@ -24,6 +24,7 @@
///////////////////////////////////////////////////////////////
/// \brief
+/// Defines the type of a geodetic transformation method
///
class MG_GEOMETRY_API MgCoordinateSystemGeodeticTransformationMethod
{
Modified: trunk/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemGridOrientation.h
===================================================================
--- trunk/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemGridOrientation.h 2014-05-26 14:17:09 UTC (rev 8160)
+++ trunk/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemGridOrientation.h 2014-05-26 14:19:31 UTC (rev 8161)
@@ -23,7 +23,7 @@
/// \{
///////////////////////////////////////////////////////////////////////////////
-/// <summary>
+/// \brief
/// An enumeration of the supported values for the <c>m_Orientation</c> member
/// of several objects related to grids and graticules. <p>
/// This value is used to qualify objects which are of the "iso" type. I.e. a
@@ -34,25 +34,24 @@
/// points which share a common <b>easting</b> value, and the "m_Value" element
/// of that object will be an <b>easting</b> value. Note that in this example,
/// the line is typically a vertical line.
-/// </summary>
class MG_GEOMETRY_API MgCoordinateSystemGridOrientation
{
PUBLISHED_API:
///////////////////////////////////////////////////////////////////////////
- /// \brief Not specified yet, initialize to this value.
- ///
+ /// \brief
+ /// Not specified yet, initialize to this value.
static const INT8 None = 0;
///////////////////////////////////////////////////////////////////////////
- /// \brief The object represents a constant easting value.
- ///
+ /// \brief
+ /// The object represents a constant easting value.
static const INT8 EastWest = 1; // generally indicates a vertical grid line
///////////////////////////////////////////////////////////////////////////
- /// \brief The object represents a constant northing value.
- ///
+ /// \brief
+ /// The object represents a constant northing value.
static const INT8 NorthSouth = 2; // generally indicates a horizontal grid line
///////////////////////////////////////////////////////////////////////////
- /// \brief Indicates the failure of an algorithm or other problem.
- ///
+ /// \brief
+ /// Indicates the failure of an algorithm or other problem.
static const INT8 Unknown = 3; // indicates a failure of an algorithm
};
Modified: trunk/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemGridSpecializationType.h
===================================================================
--- trunk/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemGridSpecializationType.h 2014-05-26 14:17:09 UTC (rev 8160)
+++ trunk/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemGridSpecializationType.h 2014-05-26 14:19:31 UTC (rev 8161)
@@ -23,7 +23,7 @@
/// \{
///////////////////////////////////////////////////////////////////////////////
-/// <summary>
+/// \brief
/// An enumeration of the various types of specialized grids/graticules
/// currently supported. A specialized grid is one for which specific
/// standards exist to which the results of this feature are compliant with.
@@ -33,7 +33,6 @@
/// with similar features and is currently entirely arbitrary. Using a
/// numeric literal instead of thes names of the defined constants is a sure
/// way to write code that will get broken in the future.
-/// </summary>
class MG_GEOMETRY_API MgCoordinateSystemGridSpecializationType
{
PUBLISHED_API:
Modified: trunk/MgDev/Common/MapGuideCommon/Services/ImageFormats.h
===================================================================
--- trunk/MgDev/Common/MapGuideCommon/Services/ImageFormats.h 2014-05-26 14:17:09 UTC (rev 8160)
+++ trunk/MgDev/Common/MapGuideCommon/Services/ImageFormats.h 2014-05-26 14:19:31 UTC (rev 8161)
@@ -30,21 +30,27 @@
/// \internal
/// The "value(xxx)" comments are used by SWIG to build constants.php. Do not alter them.
+ /// \brief
/// Gif format
static const STRING Gif; /// \if INTERNAL value("GIF") \endif
+ /// \brief
/// Jpeg format
static const STRING Jpeg; /// \if INTERNAL value("JPG") \endif
+ /// \brief
/// Png format
static const STRING Png; /// \if INTERNAL value("PNG") \endif
+ /// \brief
/// Png format
static const STRING Png8; /// \if INTERNAL value("PNG8") \endif
+ /// \brief
/// Tiff format
static const STRING Tiff; /// \if INTERNAL value("TIF") \endif
+ /// \brief
/// Raw format
static const STRING Raw; /// \if INTERNAL value("RAW") \endif
};
Modified: trunk/MgDev/Common/MapGuideCommon/Services/MappingDefs.h
===================================================================
--- trunk/MgDev/Common/MapGuideCommon/Services/MappingDefs.h 2014-05-26 14:17:09 UTC (rev 8160)
+++ trunk/MgDev/Common/MapGuideCommon/Services/MappingDefs.h 2014-05-26 14:19:31 UTC (rev 8161)
@@ -37,9 +37,11 @@
/// The "value(xxx)" comments are used by SWIG to build constants.php. Do not alter them.
/// \endif
+ /// \brief
/// Page units are in inches.
static const STRING Inches; ///\if INTERNAL value("in") \endif
+ /// \brief
/// Page units are in millimeters.
static const STRING Millimeters; ///\if INTERNAL value("mm") \endif
};
Modified: trunk/MgDev/Common/MapGuideCommon/Services/UnitType.h
===================================================================
--- trunk/MgDev/Common/MapGuideCommon/Services/UnitType.h 2014-05-26 14:17:09 UTC (rev 8160)
+++ trunk/MgDev/Common/MapGuideCommon/Services/UnitType.h 2014-05-26 14:19:31 UTC (rev 8161)
@@ -29,9 +29,11 @@
/// The "value(xxx)" comments are used by SWIG to build constants.php. Do not alter them.
/// \endif
+ /// \brief
/// US English.
static const STRING USEnglish; ///\if INTERNAL value("US-English") \endif
+ /// \brief
/// Metric.
static const STRING Metric; ///\if INTERNAL value("Metric") \endif
};
Modified: trunk/MgDev/Common/PlatformBase/Services/BaseServiceDefs.h
===================================================================
--- trunk/MgDev/Common/PlatformBase/Services/BaseServiceDefs.h 2014-05-26 14:17:09 UTC (rev 8160)
+++ trunk/MgDev/Common/PlatformBase/Services/BaseServiceDefs.h 2014-05-26 14:19:31 UTC (rev 8161)
@@ -29,39 +29,47 @@
{
PUBLISHED_API:
////////////////////////////////////////////////////////////////
+ /// \brief
/// Resource Service
static const INT16 ResourceService = 0;
////////////////////////////////////////////////////////////////
+ /// \brief
/// DWF Drawing Service
static const INT16 DrawingService = 1;
////////////////////////////////////////////////////////////////
+ /// \brief
/// FDO Feature Service
static const INT16 FeatureService = 2;
////////////////////////////////////////////////////////////////
+ /// \brief
/// Mapping Service
static const INT16 MappingService = 3;
////////////////////////////////////////////////////////////////
+ /// \brief
/// Rendering Service
static const INT16 RenderingService = 4;
////////////////////////////////////////////////////////////////
+ /// \brief
/// Tile Service
static const INT16 TileService = 5;
////////////////////////////////////////////////////////////////
+ /// \brief
/// Kml Service
static const INT16 KmlService = 6;
////////////////////////////////////////////////////////////////
+ /// \brief
/// Profiling Service
static const INT16 ProfilingService = 10;
Modified: trunk/MgDev/Common/PlatformBase/Services/FeatureCommandType.h
===================================================================
--- trunk/MgDev/Common/PlatformBase/Services/FeatureCommandType.h 2014-05-26 14:17:09 UTC (rev 8160)
+++ trunk/MgDev/Common/PlatformBase/Services/FeatureCommandType.h 2014-05-26 14:19:31 UTC (rev 8161)
@@ -31,18 +31,23 @@
{
PUBLISHED_API:
/////////////////////////////////////////////////////
+ /// \brief
/// Specifies the type of an MgInsertFeatures object.
static const int InsertFeatures = 0;
/////////////////////////////////////////////////////
+ /// \brief
/// Specifies the type of an MgUpdateFeatures object.
static const int UpdateFeatures = 1;
/////////////////////////////////////////////////////
+ /// \brief
/// Specifies the type of an MgDeleteFeatures object.
static const int DeleteFeatures = 2;
/////////////////////////////////////////////////////
+ /// \brief
/// Specifies the type of an MgLockFeatures object.
static const int LockFeatures = 3;
/////////////////////////////////////////////////////
+ /// \brief
/// Specifies the type of an MgUnlockFeatures object.
static const int UnlockFeatures = 4;
INTERNAL_API:
Modified: trunk/MgDev/Common/PlatformBase/Services/FeatureGeometricType.h
===================================================================
--- trunk/MgDev/Common/PlatformBase/Services/FeatureGeometricType.h 2014-05-26 14:17:09 UTC (rev 8160)
+++ trunk/MgDev/Common/PlatformBase/Services/FeatureGeometricType.h 2014-05-26 14:19:31 UTC (rev 8161)
@@ -35,21 +35,25 @@
{
PUBLISHED_API:
/////////////////////////////////////////////////////////////
+ /// \brief
/// Represents zero-dimensional geometric primitives, such as
/// MgPoint.
static const int Point = 1;
////////////////////////////////////////////////////////////
+ /// \brief
/// Represents one-dimensional geometric primitives, such as
/// MgLineString and MgCurveString.
static const int Curve = 2;
////////////////////////////////////////////////////////////
+ /// \brief
/// Represents two-dimensional geometric primitives, such as
/// MgPolygon and MgCurvePolygon.
static const int Surface = 4;
//////////////////////////////////////////////////////////////
+ /// \brief
/// Represents three-dimensional geometric primitives, such as
/// Cubes.
static const int Solid = 8;
Modified: trunk/MgDev/Common/PlatformBase/Services/FeatureService.h
===================================================================
--- trunk/MgDev/Common/PlatformBase/Services/FeatureService.h 2014-05-26 14:17:09 UTC (rev 8160)
+++ trunk/MgDev/Common/PlatformBase/Services/FeatureService.h 2014-05-26 14:19:31 UTC (rev 8161)
@@ -1891,6 +1891,7 @@
static const INT32 m_cls_id = PlatformBase_FeatureService_FeatureService;
};
+///\cond INTERNAL
#define MG_CHECK_FEATURE_SET_COUNT(pointer, methodname) \
if (0 == pointer->GetCount()) \
{ \
@@ -1904,6 +1905,7 @@
throw new MgInvalidPropertyTypeException(methodname, \
__LINE__, __WFILE__, NULL, L"", NULL); \
}
+///\endcond
/// \}
Modified: trunk/MgDev/Common/PlatformBase/Services/ObjectPropertyType.h
===================================================================
--- trunk/MgDev/Common/PlatformBase/Services/ObjectPropertyType.h 2014-05-26 14:17:09 UTC (rev 8160)
+++ trunk/MgDev/Common/PlatformBase/Services/ObjectPropertyType.h 2014-05-26 14:19:31 UTC (rev 8161)
@@ -24,8 +24,8 @@
///////////////////////////////////////////////////////////////
/// \brief
-/// Defines the type of an MgObjectPropertionDefinition object
-/// property, that is, whether the property ccontains a single
+/// Defines the type of an \link MgObjectPropertionDefinition \endlink object
+/// property, that is, whether the property contains a single
/// feature class object, or an unordered or ordered collection
/// of them.
///
@@ -33,21 +33,23 @@
{
PUBLISHED_API:
////////////////////////////////////////////////////////////////
+ /// \brief
/// Signifies that the object property contains a single feature
/// class object.
static const int Value = 0;
//////////////////////////////////////////////////////////////
+ /// \brief
/// Signifies that the object property contains more than one
/// feature class object. The collection of objects is in no
/// particular order relative to the identity property defined
- /// for the collection. See
- /// MgObjectPropertyDefinition::GetIdentityProperty.
+ /// for the collection. See \link MgObjectPropertyDefinition::GetIdentityProperty \endlink
static const int Collection = 1;
/////////////////////////////////////////////////////////////////
+ /// \brief
/// Signifies that the object property contains more than one
/// feature class object in ascending or descending order
/// relative to the identity property defined for the collection.
- /// See MgObjectPropertyDefinition::GetIdentityProperty.
+ /// See \link MgObjectPropertyDefinition::GetIdentityProperty \endlink
static const int OrderedCollection = 2;
INTERNAL_API:
Modified: trunk/MgDev/Common/PlatformBase/Services/RasterTypes.h
===================================================================
--- trunk/MgDev/Common/PlatformBase/Services/RasterTypes.h 2014-05-26 14:17:09 UTC (rev 8160)
+++ trunk/MgDev/Common/PlatformBase/Services/RasterTypes.h 2014-05-26 14:19:31 UTC (rev 8161)
@@ -32,27 +32,34 @@
// These correspond to FDO RasterDataModelType definitions
+ /// \brief
/// Data is organized in an unknown or provider specific manner.
static const INT32 Unknown; /// value(0)
+ /// \brief
/// Data is rectangular grid, floating point data model.
static const INT32 Data; /// value(1)
+ /// \brief
/// Data is one bit (black/white - bitonal) pixels.
static const INT32 Bitonal; /// value(2)
+ /// \brief
/// Data is monochrome (black->gray->white) pixels.
/// It is necessary to know the BitsPerPixel value to interpret the data.
static const INT32 Gray; /// value(3)
+ /// \brief
/// Data is red/green/blue (in that order) pixels.
/// It is necessary to know the BitsPerPixel value to interpret the data.
static const INT32 RGB; /// value(4)
+ /// \brief
/// 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.
static const INT32 RGBA; /// value(5)
+ /// \brief
/// Data is monochrome but backed by a pallette (value->pallette->colour) pixels.
/// It is necessary to know the BitsPerPixel value to interpret the data.
static const INT32 Palette; /// value(6)
Modified: trunk/MgDev/Common/PlatformBase/Services/ReaderType.h
===================================================================
--- trunk/MgDev/Common/PlatformBase/Services/ReaderType.h 2014-05-26 14:17:09 UTC (rev 8160)
+++ trunk/MgDev/Common/PlatformBase/Services/ReaderType.h 2014-05-26 14:19:31 UTC (rev 8161)
@@ -36,12 +36,15 @@
{
PUBLISHED_API:
/////////////////////////////////////////////////////////
+ /// \brief
/// Signifies that the object is of type MgFeatureReader.
static const int FeatureReader = 0;
//////////////////////////////////////////////////////
+ /// \brief
/// Signifies that the object is of type MgDataReader.
static const int DataReader = 1;
/////////////////////////////////////////////////////////
+ /// \brief
/// Signifies that the object is of type MgSqlDataReader.
static const int SqlDataReader = 2;
INTERNAL_API:
Modified: trunk/MgDev/Common/PlatformBase/Services/ResourceDefs.h
===================================================================
--- trunk/MgDev/Common/PlatformBase/Services/ResourceDefs.h 2014-05-26 14:17:09 UTC (rev 8160)
+++ trunk/MgDev/Common/PlatformBase/Services/ResourceDefs.h 2014-05-26 14:19:31 UTC (rev 8161)
@@ -52,10 +52,12 @@
/// \endif
////////////////////////////////////////////////////////////////
+ /// \brief
/// The repository is the \link library library \endlink.
static const STRING Library; ///\if INTERNAL value("Library") \endif
////////////////////////////////////////////////////////////////
+ /// \brief
/// The repository is a \link session_repository session repository \endlink,
/// used to store temporary data.
/// \note1
@@ -492,12 +494,15 @@
/// The "value(xxx)" comments are used by SWIG to build constants.php. Do not alter them.
/// \endif
+ /// \brief
/// No Access permission.
static const STRING NoAccess; ///\if INTERNAL value("n") \endif
+ /// \brief
/// Read-Only permission.
static const STRING ReadOnly; ///\if INTERNAL value("r") \endif
+ /// \brief
/// Read/Write permission.
static const STRING ReadWrite; ///\if INTERNAL value("r,w") \endif
};
@@ -549,12 +554,15 @@
/// The "value(xxx)" comments are used by SWIG to build constants.php. Do not alter them.
/// \endif
+ /// \brief
/// Return folders only
static const STRING Folders; ///\if INTERNAL value("Folders") \endif
+ /// \brief
/// Return files only
static const STRING Files; ///\if INTERNAL value("Files") \endif
+ /// \brief
/// Return both files and folders
static const STRING Both; ///\if INTERNAL value("Both") \endif
};
Modified: trunk/MgDev/Common/PlatformBase/Services/SpatialContextExtentType.h
===================================================================
--- trunk/MgDev/Common/PlatformBase/Services/SpatialContextExtentType.h 2014-05-26 14:17:09 UTC (rev 8160)
+++ trunk/MgDev/Common/PlatformBase/Services/SpatialContextExtentType.h 2014-05-26 14:19:31 UTC (rev 8161)
@@ -29,9 +29,11 @@
class MgSpatialContextExtentType
{
PUBLISHED_API:
+ /// \brief
/// The spatial extent of the context is static and must be specified
/// when the context is created.
static const int scStatic = 0;
+ /// \brief
/// The spatial extent of the context is dynamic and changes as data is
/// added and removed from the context.
static const int scDynamic = 1;
More information about the mapguide-commits
mailing list