[mapguide-commits] r1109 - in trunk/MgDev/Common: Foundation/Data
Foundation/System Geometry/Buffer Geometry/Spatial
PlatformBase/Services
svn_mapguide at osgeo.org
svn_mapguide at osgeo.org
Tue Feb 13 19:46:11 EST 2007
Author: philipsharman
Date: 2007-02-13 19:46:11 -0500 (Tue, 13 Feb 2007)
New Revision: 1109
Modified:
trunk/MgDev/Common/Foundation/Data/Byte.h
trunk/MgDev/Common/Foundation/System/Configuration.h
trunk/MgDev/Common/Foundation/System/FileUtil.h
trunk/MgDev/Common/Foundation/System/Ptr.h
trunk/MgDev/Common/Foundation/System/SetLocale.h
trunk/MgDev/Common/Foundation/System/Util.h
trunk/MgDev/Common/Geometry/Buffer/plgnsbak.h
trunk/MgDev/Common/Geometry/Spatial/SpatialUtility.h
trunk/MgDev/Common/PlatformBase/Services/ResourceDefs.h
Log:
Corrected some Doxygen commands in the comments. This will
ensure that some internal classes do not appear in the API
Reference.
Modified: trunk/MgDev/Common/Foundation/Data/Byte.h
===================================================================
--- trunk/MgDev/Common/Foundation/Data/Byte.h 2007-02-13 00:24:40 UTC (rev 1108)
+++ trunk/MgDev/Common/Foundation/Data/Byte.h 2007-02-14 00:46:11 UTC (rev 1109)
@@ -18,9 +18,7 @@
#ifndef _MG_BYTE
#define _MG_BYTE
-/// \defgroup MgByte MgByte
-/// \ingroup Common_Module
-/// \{
+/// \cond INTERNAL
/// \brief
/// A utility class to store bytes
@@ -178,7 +176,7 @@
INT32 m_allocLen;
AllocatorType m_allocType;
};
-/// \}
+/// \endcond
#endif
Modified: trunk/MgDev/Common/Foundation/System/Configuration.h
===================================================================
--- trunk/MgDev/Common/Foundation/System/Configuration.h 2007-02-13 00:24:40 UTC (rev 1108)
+++ trunk/MgDev/Common/Foundation/System/Configuration.h 2007-02-14 00:46:11 UTC (rev 1109)
@@ -35,6 +35,7 @@
#define MG_CONFIGURATION_CATCH_AND_THROW(methodName) \
MG_CATCH_AND_THROW(methodName) \
+/// \cond INTERNAL
//////////////////////////////////////////////////////////////////
/// Validation information on configuration properties.
///
@@ -49,6 +50,7 @@
STRING GetMinimumValue() const;
STRING GetMaximumValue() const;
};
+/// \endcond
/// \cond INTERNAL
class MG_FOUNDATION_API MgConfiguration : public MgGuardDisposable
Modified: trunk/MgDev/Common/Foundation/System/FileUtil.h
===================================================================
--- trunk/MgDev/Common/Foundation/System/FileUtil.h 2007-02-13 00:24:40 UTC (rev 1108)
+++ trunk/MgDev/Common/Foundation/System/FileUtil.h 2007-02-14 00:46:11 UTC (rev 1109)
@@ -33,6 +33,7 @@
class MG_FOUNDATION_API ACE_Recursive_Thread_Mutex;
+/// \cond INTERNAL
class MG_FOUNDATION_API MgFileUtil
{
DECLARE_CLASSNAME(MgFileUtil)
@@ -110,6 +111,7 @@
static const STRING sm_reservedCharacters;
};
+/// \endcond
/// Inline Methods
Modified: trunk/MgDev/Common/Foundation/System/Ptr.h
===================================================================
--- trunk/MgDev/Common/Foundation/System/Ptr.h 2007-02-13 00:24:40 UTC (rev 1108)
+++ trunk/MgDev/Common/Foundation/System/Ptr.h 2007-02-14 00:46:11 UTC (rev 1109)
@@ -27,6 +27,8 @@
#define SAFE_ADDREF(x) ((x != NULL) ? ((x)->AddRef(), (x)) : NULL)
class MgException;
+
+/// \cond INTERNAL
//This class ensures T implements AddRef() and Release() and also ensures
//you can't call it through the Ptr
template <class T>
@@ -36,6 +38,7 @@
virtual INT32 AddRef() = 0;
virtual INT32 Release() = 0;
};
+/// \endcond
template <class T>
#ifdef _WIN32
@@ -52,6 +55,7 @@
return lp;
}
+/// \cond INTERNAL
//Ptr smart pointer
template <class T>
class Ptr
@@ -217,6 +221,7 @@
T* p;
};
+/// \endcond
#endif
Modified: trunk/MgDev/Common/Foundation/System/SetLocale.h
===================================================================
--- trunk/MgDev/Common/Foundation/System/SetLocale.h 2007-02-13 00:24:40 UTC (rev 1108)
+++ trunk/MgDev/Common/Foundation/System/SetLocale.h 2007-02-14 00:46:11 UTC (rev 1109)
@@ -18,6 +18,7 @@
#ifndef MGSETLOCALE_H_
#define MGSETLOCALE_H_
+/// \cond INTERNAL
// This class should be used instead of ::setlocale(int category, const char * locale)
// in order to temporarily set the locale for an operation. The reason being:
// this class will automatically reset the locale back to what it was before
@@ -31,7 +32,6 @@
// }
// <-- at the point where execution resumes after the block, the old locale
// is restored whether an exception had occurred in the above code or not.
-
class MgSetLocale {
public:
@@ -44,5 +44,6 @@
std::string m_strNewLocale;
int m_category;
};
+/// \endcond
#endif
Modified: trunk/MgDev/Common/Foundation/System/Util.h
===================================================================
--- trunk/MgDev/Common/Foundation/System/Util.h 2007-02-13 00:24:40 UTC (rev 1108)
+++ trunk/MgDev/Common/Foundation/System/Util.h 2007-02-14 00:46:11 UTC (rev 1109)
@@ -32,24 +32,30 @@
// STL-related structs
+/// \cond INTERNAL
struct MgWcsICmpAscending
{
bool operator()(const wstring& s1, const wstring& s2) const
{
return (_wcsicmp(s1.c_str(), s2.c_str()) < 0);
}
+/// \endcond
};
+/// \cond INTERNAL
struct MgWcsICmpDescending
{
bool operator()(const wstring& s1, const wstring& s2) const
{
return (_wcsicmp(s1.c_str(), s2.c_str()) > 0);
}
+/// \endcond
};
class MgConfiguration;
+/// \cond INTERNAL
+//////////////////
/// \brief
/// A utility class containing methods needed for other part of
/// code
@@ -514,8 +520,10 @@
typedef void* (*MgStandardObjectCreateFunc)(int);
static bool uuidInitialized;
+/// \endcond
};
+
// Defines a macro for NULL check which would throw exception if value is null
#define CHECKNULL(pointer, methodname) \
if (pointer == NULL) \
Modified: trunk/MgDev/Common/Geometry/Buffer/plgnsbak.h
===================================================================
--- trunk/MgDev/Common/Geometry/Buffer/plgnsbak.h 2007-02-13 00:24:40 UTC (rev 1108)
+++ trunk/MgDev/Common/Geometry/Buffer/plgnsbak.h 2007-02-14 00:46:11 UTC (rev 1109)
@@ -32,6 +32,7 @@
#include "plgnbufr.h"
+/// \cond INTERNAL
class PolygonSetback : public PolygonBuffer {
public:
/// constructors (explicit destructor not required)
@@ -60,5 +61,6 @@
const int nPolyVerts[], int nPolyObjects, ProgressCallback &callback,
OrientedPolyPolygon &bufferZone);
};
-
+/// \endcond
+
#endif
Modified: trunk/MgDev/Common/Geometry/Spatial/SpatialUtility.h
===================================================================
--- trunk/MgDev/Common/Geometry/Spatial/SpatialUtility.h 2007-02-13 00:24:40 UTC (rev 1108)
+++ trunk/MgDev/Common/Geometry/Spatial/SpatialUtility.h 2007-02-14 00:46:11 UTC (rev 1109)
@@ -18,9 +18,7 @@
#ifndef MgSpatialUtility_H
#define MgSpatialUtility_H
-/// \defgroup GisSpatialUtility GisSpatialUtility
-/// \ingroup Geometry_Module_classes
-/// \{
+/// \cond INTERNAL
/// \brief
/// Spatial utility class.
@@ -126,6 +124,6 @@
MgCoordinateCollection * distinctPositions,
MgCoordinateCollection * positionsToAppend);
};
-/// \}
+/// \endcond
#endif
Modified: trunk/MgDev/Common/PlatformBase/Services/ResourceDefs.h
===================================================================
--- trunk/MgDev/Common/PlatformBase/Services/ResourceDefs.h 2007-02-13 00:24:40 UTC (rev 1108)
+++ trunk/MgDev/Common/PlatformBase/Services/ResourceDefs.h 2007-02-14 00:46:11 UTC (rev 1109)
@@ -349,7 +349,7 @@
static const STRING String; ///\if INTERNAL value("String") \endif
};
-
+/// \cond INTERNAL
///////////////////////////////////////////////////////////////////////////////
/// \brief
/// Types of pre-processing to apply to resource content before
@@ -365,6 +365,7 @@
///
static const STRING Substitution; ///\if INTERNAL value("Substitution") \endif
};
+/// \endcond
///////////////////////////////////////////////////////////////////////////////
More information about the mapguide-commits
mailing list