[mapguide-commits] r4550 -
trunk/MgDev/Common/Geometry/CoordinateSystem
svn_mapguide at osgeo.org
svn_mapguide at osgeo.org
Thu Jan 28 15:10:43 EST 2010
Author: NormOlsen
Date: 2010-01-28 15:10:42 -0500 (Thu, 28 Jan 2010)
New Revision: 4550
Modified:
trunk/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemGridOrientation.h
trunk/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemGridSpecializationType.h
trunk/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemGrids.h
trunk/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemMgrs.h
trunk/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemMgrsGridLevel.h
Log:
Trac Ticket 1251 -- Adjust source code files tso as to produce correct documentation.
Modified: trunk/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemGridOrientation.h
===================================================================
--- trunk/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemGridOrientation.h 2010-01-28 07:19:33 UTC (rev 4549)
+++ trunk/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemGridOrientation.h 2010-01-28 20:10:42 UTC (rev 4550)
@@ -18,6 +18,10 @@
#ifndef _MGCOORDINATESYSTEMGRIDORIENTATION_H_
#define _MGCOORDINATESYSTEMGRIDORIENTATION_H_
+/// \defgroup MgCoordinateSystemGridOrientation MgCoordinateSystemGridOrientation
+/// \ingroup Coordinate_System_classes
+/// \{
+
///////////////////////////////////////////////////////////////////////////////
/// <summary>
/// An enumeration of the supported values for the <c>m_Orientation</c> member
@@ -48,4 +52,6 @@
static const INT8 Unknown = 3; // indicates a failure of an algorithm
};
+/// \}
+
#endif //_MGCOORDINATESYSTEMGRIDORIENTATION_H_
Modified: trunk/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemGridSpecializationType.h
===================================================================
--- trunk/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemGridSpecializationType.h 2010-01-28 07:19:33 UTC (rev 4549)
+++ trunk/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemGridSpecializationType.h 2010-01-28 20:10:42 UTC (rev 4550)
@@ -18,6 +18,10 @@
#ifndef _MGCOORDINATESYSTEMGRIDSPECIALIZATIONTYPE_H_
#define _MGCOORDINATESYSTEMGRIDSPECIALIZATIONTYPE_H_
+/// \defgroup MgCoordinateSystemGridSpecializationType MgCoordinateSystemGridSpecializationType
+/// \ingroup Coordinate_System_classes
+/// \{
+
///////////////////////////////////////////////////////////////////////////////
/// <summary>
/// An enumeration of the various types of specialized grids/graticules
@@ -52,4 +56,6 @@
static const INT32 Unknown = 65366;
};
+/// \}
+
#endif //_MGCOORDINATESYSTEMGRIDSPECIALIZATIONTYPE_H_
Modified: trunk/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemGrids.h
===================================================================
--- trunk/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemGrids.h 2010-01-28 07:19:33 UTC (rev 4549)
+++ trunk/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemGrids.h 2010-01-28 20:10:42 UTC (rev 4550)
@@ -49,6 +49,9 @@
class MgCoordinateSystemGridTick; // a position in viewport coordinates and a grid value
// as a double
+/// \defgroup MgCoordinateSystemGridSpecification MgCoordinateSystemGridSpecification
+/// \ingroup Coordinate_System_classes
+/// \{
///////////////////////////////////////////////////////////////////////////////
/// <summary>
@@ -666,7 +669,12 @@
CLASS_ID:
static const INT32 m_cls_id = CoordinateSystem_CoordinateSystemGridSpecification;
};
+/// \}
+/// \defgroup MgCoordinateSystemGridBoundary MgCoordinateSystemGridBoundary
+/// \ingroup Coordinate_System_classes
+/// \{
+
//=============================================================================
// External to this interface, boundary objects are always in the viewport
// (i.e. target) coordinate system.
@@ -702,6 +710,12 @@
static const INT32 m_cls_id = CoordinateSystem_CoordinateSystemGridBoundary;
};
+/// \}
+
+/// \defgroup MgCoordinateSystemGridBase MgCoordinateSystemGridBase
+/// \ingroup Coordinate_System_classes
+/// \{
+
//=============================================================================
// Abstract base class for all grid generation objects (generic and
// specialized).
@@ -758,7 +772,12 @@
CLASS_ID:
static const INT32 m_cls_id = CoordinateSystem_CoordinateSystemGridBase;
};
+/// \}
+/// \defgroup MgCoordinateSystemGridLine MgCoordinateSystemGridLine
+/// \ingroup Coordinate_System_classes
+/// \{
+
//=============================================================================
// An MgCoordinateSystemGridLine object is a grid value (as a double) and a
// collection of line strings, where each individual line string being
@@ -781,11 +800,25 @@
CLASS_ID:
static const INT32 m_cls_id = CoordinateSystem_CoordinateSystemGridLine;
};
+/// \}
+/// \defgroup MgCoordinateSystemGridRegion MgCoordinateSystemGridRegion
+/// \ingroup Coordinate_System_classes
+/// \{
+
//=============================================================================
// An MgCoordinateSystemGridRegion object consists of a label and a polygon.
// The polygon is always in the viewport coordinate system. Such an object
// is used, for example, to label and delineate an MGRS 100Km UTM grid zone.
+
+///////////////////////////////////////////////////////////////////////////////
+///////////////////////////////////////////////////////////////////////////////
+// //
+// This API has been found to be problematical in the initial release. It //
+// will be deprecated in the next release. //
+// //
+///////////////////////////////////////////////////////////////////////////////
+///////////////////////////////////////////////////////////////////////////////
class MG_GEOMETRY_API MgCoordinateSystemGridRegion : public MgGuardDisposable
{
PUBLISHED_API:
@@ -808,7 +841,12 @@
CLASS_ID:
static const INT32 m_cls_id = CoordinateSystem_CoordinateSystemGridRegion;
};
+/// \}
+
+/// \defgroup MgCoordinateSystemGridTick MgCoordinateSystemGridTick
+/// \ingroup Coordinate_System_classes
+/// \{
//=============================================================================
// An MgCoordinateSystemGridTick object consists of a grid value, a tick
// location point in viewport coordinates, and a 2D unit direction vector.
@@ -831,7 +869,11 @@
CLASS_ID:
static const INT32 m_cls_id = CoordinateSystem_CoordinateSystemGridTick;
};
+/// \}
+/// \defgroup MgCoordinateSystemGridLineCollection MgCoordinateSystemGridLineCollection
+/// \ingroup Coordinate_System_classes
+/// \{
//=============================================================================
// An MgCoordinateSystemGridLineCollection is collection of
// MgCoordinateSystemGridLine objects. As manufactured, grid horizontal lines
@@ -856,7 +898,11 @@
CLASS_ID:
static const INT32 m_cls_id = CoordinateSystem_CoordinateSystemGridLineCollection;
};
+/// \}
+/// \defgroup MgCoordinateSystemGridRegionCollection MgCoordinateSystemGridRegionCollection
+/// \ingroup Coordinate_System_classes
+/// \{
//=============================================================================
// An MgCoordinateSystemGridRegionCollection is collection of
// MgCoordinateSystemGridRegion objects.
@@ -876,7 +922,11 @@
CLASS_ID:
static const INT32 m_cls_id = CoordinateSystem_CoordinateSystemGridRegionCollection;
};
+/// \}
+/// \defgroup MgCoordinateSystemGridTickCollection MgCoordinateSystemGridTickCollection
+/// \ingroup Coordinate_System_classes
+/// \{
//=============================================================================
// An MgCoordinateSystemGridTickCollection is collection of
// MgCoordinateSystemGridTick objects. MgCoordinateSystemGridTickCollection
@@ -898,5 +948,6 @@
CLASS_ID:
static const INT32 m_cls_id = CoordinateSystem_CoordinateSystemGridTickCollection;
};
+/// \}
#endif //_MGCOORDINATESYSTEMGRIDS_H_
Modified: trunk/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemMgrs.h
===================================================================
--- trunk/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemMgrs.h 2010-01-28 07:19:33 UTC (rev 4549)
+++ trunk/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemMgrs.h 2010-01-28 20:10:42 UTC (rev 4550)
@@ -18,6 +18,10 @@
#ifndef _MGCOORDINATESYSTEMMGRS_H_
#define _MGCOORDINATESYSTEMMGRS_H_
+/// \defgroup MgCoordinateSystemMgrs MgCoordinateSystemMgrs
+/// \ingroup Coordinate_System_classes
+/// \{
+
///////////////////////////////////////////////////////////////////////////////
/// This object carries most, if not all, intelligence specific to the MGRS
/// (Military Grid Reference System) grid standard. It can be used at two
@@ -115,4 +119,6 @@
static const INT32 m_cls_id = CoordinateSystem_CoordinateSystemMgrs;
};
+/// \}
+
#endif //_MGCOORDINATESYSTEMMGRS_H_
Modified: trunk/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemMgrsGridLevel.h
===================================================================
--- trunk/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemMgrsGridLevel.h 2010-01-28 07:19:33 UTC (rev 4549)
+++ trunk/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemMgrsGridLevel.h 2010-01-28 20:10:42 UTC (rev 4550)
@@ -18,6 +18,10 @@
#ifndef _MGCOORDINATESYSTEMMGRSGRIDLEVEL_H_
#define _MGCOORDINATESYSTEMMGRSGRIDLEVEL_H_
+/// \defgroup MgCoordinateSystemMgrsGridLevel MgCoordinateSystemMgrsGridLevel
+/// \ingroup Coordinate_System_classes
+/// \{
+
///////////////////////////////////////////////////////////////
/// \brief
/// Defines constants used to indicate the MGRS grid level
@@ -37,4 +41,6 @@
static const INT32 MgrsUnknown = 99;
};
+/// \}
+
#endif //_MGCOORDINATESYSTEMMGRSGRIDLEVEL_H_
More information about the mapguide-commits
mailing list