[mapguide-commits] r1089 - trunk/MgDev/Common/PlatformBase/Services
svn_mapguide at osgeo.org
svn_mapguide at osgeo.org
Fri Feb 2 12:55:21 EST 2007
Author: philipsharman
Date: 2007-02-02 12:55:19 -0500 (Fri, 02 Feb 2007)
New Revision: 1089
Modified:
trunk/MgDev/Common/PlatformBase/Services/Resource.h
trunk/MgDev/Common/PlatformBase/Services/ResourceDefs.h
trunk/MgDev/Common/PlatformBase/Services/ResourceIdentifier.h
trunk/MgDev/Common/PlatformBase/Services/ResourceService.h
Log:
Improved the Doxygen commands in the comments. This makes the
TOC entries more consistent with the other services, and should
make the navigation easier.
Modified: trunk/MgDev/Common/PlatformBase/Services/Resource.h
===================================================================
--- trunk/MgDev/Common/PlatformBase/Services/Resource.h 2007-02-02 04:34:08 UTC (rev 1088)
+++ trunk/MgDev/Common/PlatformBase/Services/Resource.h 2007-02-02 17:55:19 UTC (rev 1089)
@@ -15,9 +15,6 @@
// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
//
-/// \defgroup MgResource MgResource
-/// \ingroup Other_Resource_Service_classes
-/// \{
#ifndef _MG_RESOURCE_H_
#define _MG_RESOURCE_H_
@@ -28,10 +25,8 @@
/// \brief
/// The abstract base class for all resource types.
///
-/// \todo
-/// [[Need examples. This is used in the Maps and
-/// Layers API.]]
-
+/// \ingroup Resource_Service_classes
+///
class MG_PLATFORMBASE_API MgResource : public MgNamedSerializable
{
PUBLISHED_API:
@@ -140,6 +135,6 @@
private:
static STRING m_resourceDataTag;
};
-/// \}
+
#endif
Modified: trunk/MgDev/Common/PlatformBase/Services/ResourceDefs.h
===================================================================
--- trunk/MgDev/Common/PlatformBase/Services/ResourceDefs.h 2007-02-02 04:34:08 UTC (rev 1088)
+++ trunk/MgDev/Common/PlatformBase/Services/ResourceDefs.h 2007-02-02 17:55:19 UTC (rev 1089)
@@ -33,9 +33,6 @@
};
/// \endcond INTERNAL
-/// \defgroup MgRepositoryType MgRepositoryType
-/// \ingroup Other_Resource_Service_classes
-/// \{
///////////////////////////////////////////////////////////////////////////////
/// \brief
@@ -44,6 +41,9 @@
/// MgResourceIdentifier::SetRepositoryType
/// \see
/// MgResourceIdentifier::GetRepositoryType
+///
+/// \ingroup Resource_Service_classes
+///
class MG_PLATFORMBASE_API MgRepositoryType
{
PUBLISHED_API:
@@ -72,6 +72,9 @@
/// MgResourceIdentifier::GetResourceType
/// \see
/// MgResourceIdentifier::SetResourceType
+///
+/// \ingroup Resource_Service_classes
+///
class MG_PLATFORMBASE_API MgResourceType
{
PUBLISHED_API:
@@ -223,6 +226,8 @@
/// \todo
/// [[Add examples for all these. ]]
///
+/// \ingroup Resource_Service_classes
+///
class MG_PLATFORMBASE_API MgResourceTag
{
PUBLISHED_API:
@@ -272,6 +277,8 @@
/// \brief
/// Defines reserved names for resource data.
///
+/// \ingroup Resource_Service_classes
+///
class MG_PLATFORMBASE_API MgResourceDataName
{
PUBLISHED_API:
@@ -293,6 +300,8 @@
/// \remarks
/// For more information, see the <i>MapGuide Developer's Guide</i>.
///
+/// \ingroup Resource_Service_classes
+///
class MG_PLATFORMBASE_API MgResourceDataType
{
PUBLISHED_API:
@@ -346,6 +355,8 @@
/// Types of pre-processing to apply to resource content before
/// it is returned from \link MgResourceService::GetResourceContent GetResourceContent \endlink.
///
+/// \ingroup Resource_Service_classes
+///
class MG_PLATFORMBASE_API MgResourcePreProcessingType
{
PUBLISHED_API:
@@ -360,6 +371,8 @@
/// \brief
/// Types of resource permissions.
///
+/// \ingroup Resource_Service_classes
+///
class MG_PLATFORMBASE_API MgResourcePermission
{
PUBLISHED_API:
@@ -376,7 +389,6 @@
/// Read/Write permission.
static const STRING ReadWrite; ///\if INTERNAL value("r,w") \endif
};
-/// \}
/// \cond INTERNAL
Modified: trunk/MgDev/Common/PlatformBase/Services/ResourceIdentifier.h
===================================================================
--- trunk/MgDev/Common/PlatformBase/Services/ResourceIdentifier.h 2007-02-02 04:34:08 UTC (rev 1088)
+++ trunk/MgDev/Common/PlatformBase/Services/ResourceIdentifier.h 2007-02-02 17:55:19 UTC (rev 1089)
@@ -15,9 +15,6 @@
// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
//
-/// \defgroup MgResourceIdentifier MgResourceIdentifier
-/// \ingroup Other_Resource_Service_classes
-/// \{
#ifndef MG_RESOURCE_IDENTIFIER_H
#define MG_RESOURCE_IDENTIFIER_H
@@ -47,7 +44,8 @@
/// If the resource is a folder (for example, <c>Library://Maps/North
/// America/</c>), you must include the trailing slash.
///
-
+/// \ingroup Resource_Service_classes
+///
class MG_PLATFORMBASE_API MgResourceIdentifier : public MgSerializable
{
DECLARE_CREATE_OBJECT();
@@ -827,6 +825,6 @@
CLASS_ID:
static const INT32 m_cls_id = PlatformBase_ResourceService_ResourceIdentifier;
};
-/// \}
+
#endif
Modified: trunk/MgDev/Common/PlatformBase/Services/ResourceService.h
===================================================================
--- trunk/MgDev/Common/PlatformBase/Services/ResourceService.h 2007-02-02 04:34:08 UTC (rev 1088)
+++ trunk/MgDev/Common/PlatformBase/Services/ResourceService.h 2007-02-02 17:55:19 UTC (rev 1089)
@@ -23,6 +23,7 @@
class MgRepository;
+
//////////////////////////////////////////////////////////////////
/// \brief
/// Enables you to manipulate repositories and resources.
@@ -34,6 +35,9 @@
/// <li>get, set, rename, list, and delete resource data</li>
/// <li>set permission for repositories and resources</li>
/// </ul>
+///
+/// \ingroup Resource_Service_classes
+///
class MG_PLATFORMBASE_API MgResourceService : public MgService
{
INTERNAL_API:
@@ -201,8 +205,6 @@
/// </tr>
/// </table>
///
- /// \ingroup WorkingWithRepositories
- ///
virtual void UpdateRepository(MgResourceIdentifier* resource, MgByteReader* content, MgByteReader* header) = 0;
///////////////////////////////////////////////////////////////////////////
@@ -521,8 +523,6 @@
/// \see
/// GetResourceHeader
///
- /// \ingroup WorkingWithResources
- ///
virtual void SetResource(MgResourceIdentifier* resource, MgByteReader* content, MgByteReader* header) = 0;
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
@@ -565,8 +565,6 @@
/// \see
/// GetMetadata
///
- /// \ingroup WorkingWithResources
- ///
virtual void SetResourceMetadata(MgResourceIdentifier* resource, MgByteReader* content);
@@ -625,8 +623,6 @@
/// The API generates an exception if you try to delete a
/// non-existent resource.
///
- /// \ingroup WorkingWithResources
- ///
virtual void DeleteResource(MgResourceIdentifier* resource) = 0;
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
@@ -709,8 +705,6 @@
/// in the source folder are overwritten. The rest should are
/// left intact.
///
- /// \ingroup WorkingWithResources
- ///
virtual void MoveResource(MgResourceIdentifier* sourceResource,
MgResourceIdentifier* destResource, bool overwrite) = 0;
@@ -785,8 +779,6 @@
/// in the source folder are overwritten. The rest should are
/// left intact.
///
- /// \ingroup WorkingWithResources
- ///
virtual void CopyResource(MgResourceIdentifier* sourceResource,
MgResourceIdentifier* destResource, bool overwrite) = 0;
@@ -832,8 +824,6 @@
/// \see
/// SetResource
///
- /// \ingroup WorkingWithResources
- ///
MgByteReader* GetResourceContent(MgResourceIdentifier* resource);
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
@@ -866,8 +856,6 @@
/// \see
/// SetResourceMetadata
///
- /// \ingroup WorkingWithResources
- ///
virtual MgByteReader* GetResourceMetadata(MgResourceIdentifier* resource);
@@ -911,8 +899,6 @@
/// \see
/// SetResource
///
- /// \ingroup WorkingWithResources
- ///
virtual MgByteReader* GetResourceHeader(MgResourceIdentifier* resource) = 0;
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
@@ -972,8 +958,6 @@
/// </ul>
///
///
- /// \ingroup WorkingWithResources
- ///
virtual void ChangeResourceOwner(MgResourceIdentifier* resource,
CREFSTRING owner, bool includeDescendants) = 0;
@@ -1030,8 +1014,6 @@
/// You must be logged in as the Administrator or the current \link owner owner \endlink
/// to use this method.
///
- /// \ingroup WorkingWithResources
- ///
virtual void InheritPermissionsFrom(MgResourceIdentifier* resource) = 0;
///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
@@ -1142,8 +1124,6 @@
/// \see
/// DeleteResourceData
///
- /// \ingroup WorkingWithResourceData
- ///
virtual void SetResourceData(MgResourceIdentifier* resource,
CREFSTRING dataName, CREFSTRING dataType, MgByteReader* data) = 0;
@@ -1192,9 +1172,6 @@
/// \see
/// RenameResourceData
///
- ///
- /// \ingroup WorkingWithResourceData
- ///
virtual void DeleteResourceData(MgResourceIdentifier* resource, CREFSTRING dataName) = 0;
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
@@ -1253,8 +1230,6 @@
/// DeleteResourceData
///
///
- /// \ingroup WorkingWithResourceData
- ///
virtual void RenameResourceData(MgResourceIdentifier* resource,
CREFSTRING oldDataName, CREFSTRING newDataName, bool overwrite) = 0;
@@ -1307,8 +1282,6 @@
/// \see
/// DeleteResourceData
///
- /// \ingroup WorkingWithResourceData
- ///
MgByteReader* GetResourceData(MgResourceIdentifier* resource,
CREFSTRING dataName);
@@ -1367,8 +1340,6 @@
/// \see
/// DeleteResourceData
///
- /// \ingroup WorkingWithResourceData
- ///
virtual MgByteReader* EnumerateResourceData(MgResourceIdentifier* resource) = 0;
//////////////////////////////////////////////////////////////////////////////
@@ -1410,8 +1381,6 @@
/// \exception MgInvalidRepositoryNameException
/// \exception MgInvalidRepositoryTypeException
///
- /// \ingroup WorkingWithRepositories
- ///
virtual MgByteReader* GetRepositoryContent(MgResourceIdentifier* resource) = 0;
/////////////////////////////////////////////////////////////////////////////
@@ -1453,8 +1422,6 @@
/// \exception MgInvalidRepositoryNameException
/// \exception MgInvalidRepositoryTypeException
///
- /// \ingroup WorkingWithRepositories
- ///
virtual MgByteReader* GetRepositoryHeader(MgResourceIdentifier* resource) = 0;
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
@@ -1506,8 +1473,6 @@
/// \exception MgInvalidResourceNameException
/// \exception MgInvalidResourceTypeException
///
- /// \ingroup WorkingWithResources
- ///
virtual MgByteReader* EnumerateReferences(MgResourceIdentifier* resource) = 0;
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
@@ -1533,10 +1498,6 @@
/// \return
/// Returns true if the resource exists, false otherwise.
///
- ///
- ///
- /// \ingroup WorkingWithResources
- ///
virtual bool ResourceExists(MgResourceIdentifier* resource);
INTERNAL_API:
@@ -1756,4 +1717,5 @@
};
};
+
#endif
More information about the mapguide-commits
mailing list