[mapguide-commits] r6962 - in branches/2.4/MgDev: Desktop/MgDesktop/MapLayer Desktop/MgDesktop/Services Desktop/MgDesktop/Services/Feature Desktop/MgDesktop/Services/Rendering Desktop/MgDesktop/Services/Resource Doc Doc/PostProcessor Doc/external_topics
svn_mapguide at osgeo.org
svn_mapguide at osgeo.org
Wed Aug 29 11:20:33 PDT 2012
Author: jng
Date: 2012-08-29 11:20:32 -0700 (Wed, 29 Aug 2012)
New Revision: 6962
Added:
branches/2.4/MgDev/Doc/MgDesktop_Doxyfile
branches/2.4/MgDev/Doc/MgDesktop_run_doxygen.bat
branches/2.4/MgDev/Doc/PostProcessor/post_process.MgDesktop.pl
branches/2.4/MgDev/Doc/external_topics/Desktop_Introduction.h
Modified:
branches/2.4/MgDev/Desktop/MgDesktop/MapLayer/Layer.h
branches/2.4/MgDev/Desktop/MgDesktop/MapLayer/Map.h
branches/2.4/MgDev/Desktop/MgDesktop/MapLayer/Selection.h
branches/2.4/MgDev/Desktop/MgDesktop/Services/ByteSourceRasterStreamImpl.h
branches/2.4/MgDev/Desktop/MgDesktop/Services/DataReader.h
branches/2.4/MgDev/Desktop/MgDesktop/Services/DrawingService.h
branches/2.4/MgDev/Desktop/MgDesktop/Services/Feature/GwsFeatureReader.h
branches/2.4/MgDev/Desktop/MgDesktop/Services/Feature/RdbmsFeatureSourceParams.h
branches/2.4/MgDev/Desktop/MgDesktop/Services/FeatureReader.h
branches/2.4/MgDev/Desktop/MgDesktop/Services/FeatureService.h
branches/2.4/MgDev/Desktop/MgDesktop/Services/ImageFormats.h
branches/2.4/MgDev/Desktop/MgDesktop/Services/MappingService.h
branches/2.4/MgDev/Desktop/MgDesktop/Services/ProfilingService.h
branches/2.4/MgDev/Desktop/MgDesktop/Services/Rendering/DwfVersion.h
branches/2.4/MgDev/Desktop/MgDesktop/Services/Rendering/FeatureInfoRenderer.h
branches/2.4/MgDev/Desktop/MgDesktop/Services/Rendering/FeatureInformation.h
branches/2.4/MgDev/Desktop/MgDesktop/Services/Rendering/Layout.h
branches/2.4/MgDev/Desktop/MgDesktop/Services/Rendering/MapPlot.h
branches/2.4/MgDev/Desktop/MgDesktop/Services/Rendering/MapPlotCollection.h
branches/2.4/MgDev/Desktop/MgDesktop/Services/Rendering/MapPlotInstruction.h
branches/2.4/MgDev/Desktop/MgDesktop/Services/Rendering/PlotSpecification.h
branches/2.4/MgDev/Desktop/MgDesktop/Services/Rendering/RenderingOptions.h
branches/2.4/MgDev/Desktop/MgDesktop/Services/Rendering/UnitType.h
branches/2.4/MgDev/Desktop/MgDesktop/Services/RenderingService.h
branches/2.4/MgDev/Desktop/MgDesktop/Services/Resource/UnmanagedDataType.h
branches/2.4/MgDev/Desktop/MgDesktop/Services/ResourceService.h
branches/2.4/MgDev/Desktop/MgDesktop/Services/ScrollableFeatureReader.h
branches/2.4/MgDev/Desktop/MgDesktop/Services/ServiceFactory.h
branches/2.4/MgDev/Desktop/MgDesktop/Services/SqlReader.h
branches/2.4/MgDev/Desktop/MgDesktop/Services/TileService.h
branches/2.4/MgDev/Desktop/MgDesktop/Services/Transaction.h
Log:
#2097: API documentation updates for mg-desktop
- Add a mg-desktop specific doxygen configuration file and build script
- Prepare mg-desktop headers for doxygen. Only grouping at the moment.
Modified: branches/2.4/MgDev/Desktop/MgDesktop/MapLayer/Layer.h
===================================================================
--- branches/2.4/MgDev/Desktop/MgDesktop/MapLayer/Layer.h 2012-08-29 18:16:56 UTC (rev 6961)
+++ branches/2.4/MgDev/Desktop/MgDesktop/MapLayer/Layer.h 2012-08-29 18:20:32 UTC (rev 6962)
@@ -5,6 +5,8 @@
class MgdScrollableFeatureReader;
+/// \ingroup Desktop_Module
+/// \{
class MG_DESKTOP_API MgdLayer : public MgLayerBase
{
MG_DECL_DYNCREATE()
@@ -103,5 +105,5 @@
CLASS_ID:
static const INT32 m_cls_id = MapGuide_Desktop_MapLayer_Layer;
};
-
+/// \}
#endif
\ No newline at end of file
Modified: branches/2.4/MgDev/Desktop/MgDesktop/MapLayer/Map.h
===================================================================
--- branches/2.4/MgDev/Desktop/MgDesktop/MapLayer/Map.h 2012-08-29 18:16:56 UTC (rev 6961)
+++ branches/2.4/MgDev/Desktop/MgDesktop/MapLayer/Map.h 2012-08-29 18:20:32 UTC (rev 6962)
@@ -11,6 +11,8 @@
class MgServiceFactory;
+/// \ingroup Desktop_Module
+/// \{
class MG_DESKTOP_API MgdMap : public MgMapBase
{
MG_DECL_DYNCREATE()
@@ -126,5 +128,5 @@
INT32 m_watermarkUsage;
};
-
+/// \}
#endif
\ No newline at end of file
Modified: branches/2.4/MgDev/Desktop/MgDesktop/MapLayer/Selection.h
===================================================================
--- branches/2.4/MgDev/Desktop/MgDesktop/MapLayer/Selection.h 2012-08-29 18:16:56 UTC (rev 6961)
+++ branches/2.4/MgDev/Desktop/MgDesktop/MapLayer/Selection.h 2012-08-29 18:20:32 UTC (rev 6962)
@@ -4,6 +4,8 @@
#include "MgDesktop.h"
#include "Map.h"
+/// \ingroup Desktop_Module
+/// \{
class MG_DESKTOP_API MgdSelection : public MgSelectionBase
{
MG_DECL_DYNCREATE()
@@ -45,5 +47,5 @@
CLASS_ID:
static const INT32 m_cls_id = MapGuide_Desktop_MapLayer_Selection;
};
-
+/// \}
#endif
\ No newline at end of file
Modified: branches/2.4/MgDev/Desktop/MgDesktop/Services/ByteSourceRasterStreamImpl.h
===================================================================
--- branches/2.4/MgDev/Desktop/MgDesktop/Services/ByteSourceRasterStreamImpl.h 2012-08-29 18:16:56 UTC (rev 6961)
+++ branches/2.4/MgDev/Desktop/MgDesktop/Services/ByteSourceRasterStreamImpl.h 2012-08-29 18:20:32 UTC (rev 6962)
@@ -21,6 +21,7 @@
#include "MgDesktop.h"
#include "Fdo.h"
+///\cond INTERNAL
/////////////////////////////////////////////////////////////////
///<summary>
/// ByteSourceSocketStreamImpl provides access to the bytes on a file source
@@ -91,5 +92,5 @@
private:
FdoIStreamReaderTmpl<FdoByte>* m_stream;
};
-
+///\endcond
#endif
Modified: branches/2.4/MgDev/Desktop/MgDesktop/Services/DataReader.h
===================================================================
--- branches/2.4/MgDev/Desktop/MgDesktop/Services/DataReader.h 2012-08-29 18:16:56 UTC (rev 6961)
+++ branches/2.4/MgDev/Desktop/MgDesktop/Services/DataReader.h 2012-08-29 18:20:32 UTC (rev 6962)
@@ -6,6 +6,8 @@
class FdoIDataReader;
class MgFeatureConnection;
+/// \ingroup Desktop_Module
+/// \{
class MG_DESKTOP_API MgdDataReader : public MgDataReader
{
INTERNAL_API:
@@ -110,5 +112,5 @@
FdoIDataReader* m_reader;
Ptr<MgFeatureConnection> m_connection;
};
-
+/// \}
#endif
\ No newline at end of file
Modified: branches/2.4/MgDev/Desktop/MgDesktop/Services/DrawingService.h
===================================================================
--- branches/2.4/MgDev/Desktop/MgDesktop/Services/DrawingService.h 2012-08-29 18:16:56 UTC (rev 6961)
+++ branches/2.4/MgDev/Desktop/MgDesktop/Services/DrawingService.h 2012-08-29 18:20:32 UTC (rev 6962)
@@ -3,6 +3,8 @@
#include "MgDesktop.h"
+/// \ingroup Desktop_Module
+/// \{
class MG_DESKTOP_API MgdDrawingService : public MgService
{
DECLARE_CLASSNAME(MgdDrawingService)
@@ -270,5 +272,5 @@
bool m_bOpenTempOutputW2dFile;
STRING m_tempOutputW2dFileName;
};
-
+/// \}
#endif
\ No newline at end of file
Modified: branches/2.4/MgDev/Desktop/MgDesktop/Services/Feature/GwsFeatureReader.h
===================================================================
--- branches/2.4/MgDev/Desktop/MgDesktop/Services/Feature/GwsFeatureReader.h 2012-08-29 18:16:56 UTC (rev 6961)
+++ branches/2.4/MgDev/Desktop/MgDesktop/Services/Feature/GwsFeatureReader.h 2012-08-29 18:20:32 UTC (rev 6962)
@@ -21,6 +21,7 @@
#include "FeatureDefs.h"
#include "GwsQueryEngine.h"
+///\cond INTERNAL
class GwsRightSideIterator
{
public:
@@ -39,7 +40,7 @@
// features
bool m_bHasData;
};
-
+///\endcond
typedef std::multimap<STRING, GwsRightSideIterator> GwsFeatureIteratorMap;
typedef std::pair<STRING, GwsRightSideIterator> GwsFeatureIteratorPair;
Modified: branches/2.4/MgDev/Desktop/MgDesktop/Services/Feature/RdbmsFeatureSourceParams.h
===================================================================
--- branches/2.4/MgDev/Desktop/MgDesktop/Services/Feature/RdbmsFeatureSourceParams.h 2012-08-29 18:16:56 UTC (rev 6961)
+++ branches/2.4/MgDev/Desktop/MgDesktop/Services/Feature/RdbmsFeatureSourceParams.h 2012-08-29 18:20:32 UTC (rev 6962)
@@ -6,6 +6,8 @@
// Parameter class for creating RDBMS data stores
//
//
+/// \ingroup Desktop_Module
+/// \{
class MG_DESKTOP_API MgRdbmsFeatureSourceParams : public MgFeatureSourceParams
{
PUBLISHED_API:
@@ -81,5 +83,5 @@
virtual void Serialize(MgStream* stream);
virtual void Deserialize(MgStream* stream);
};
-
+/// \}
#endif
\ No newline at end of file
Modified: branches/2.4/MgDev/Desktop/MgDesktop/Services/FeatureReader.h
===================================================================
--- branches/2.4/MgDev/Desktop/MgDesktop/Services/FeatureReader.h 2012-08-29 18:16:56 UTC (rev 6961)
+++ branches/2.4/MgDev/Desktop/MgDesktop/Services/FeatureReader.h 2012-08-29 18:20:32 UTC (rev 6962)
@@ -8,6 +8,8 @@
class MgAgfReaderWriter;
class MgFeatureConnection;
+/// \ingroup Desktop_Module
+/// \{
class MG_DESKTOP_API MgdFeatureReader : public MgFeatureReader
{
INTERNAL_API:
@@ -125,5 +127,5 @@
Ptr<MgClassDefinition> m_classDef;
Ptr<MgFeatureConnection> m_connection;
};
-
+/// \}
#endif
\ No newline at end of file
Modified: branches/2.4/MgDev/Desktop/MgDesktop/Services/FeatureService.h
===================================================================
--- branches/2.4/MgDev/Desktop/MgDesktop/Services/FeatureService.h 2012-08-29 18:16:56 UTC (rev 6961)
+++ branches/2.4/MgDev/Desktop/MgDesktop/Services/FeatureService.h 2012-08-29 18:20:32 UTC (rev 6962)
@@ -28,7 +28,8 @@
{
class Extension;
}
-
+/// \ingroup Desktop_Module
+/// \{
class MG_DESKTOP_API MgdFeatureService : public MgFeatureService
{
DECLARE_CLASSNAME(MgdFeatureService)
@@ -265,5 +266,5 @@
protected:
virtual INT32 GetClassId() { return m_cls_id; }
};
-
+/// \}
#endif
\ No newline at end of file
Modified: branches/2.4/MgDev/Desktop/MgDesktop/Services/ImageFormats.h
===================================================================
--- branches/2.4/MgDev/Desktop/MgDesktop/Services/ImageFormats.h 2012-08-29 18:16:56 UTC (rev 6961)
+++ branches/2.4/MgDev/Desktop/MgDesktop/Services/ImageFormats.h 2012-08-29 18:20:32 UTC (rev 6962)
@@ -2,7 +2,8 @@
#define DESKTOP_IMAGE_FORMATS_H
#include "MgDesktop.h"
-
+/// \ingroup Desktop_Module
+/// \{
class MG_DESKTOP_API MgImageFormats
{
PUBLISHED_API:
@@ -27,5 +28,5 @@
/// Raw format
static const STRING Raw; /// \if INTERNAL value("RAW") \endif
};
-
+/// \}
#endif
\ No newline at end of file
Modified: branches/2.4/MgDev/Desktop/MgDesktop/Services/MappingService.h
===================================================================
--- branches/2.4/MgDev/Desktop/MgDesktop/Services/MappingService.h 2012-08-29 18:16:56 UTC (rev 6961)
+++ branches/2.4/MgDev/Desktop/MgDesktop/Services/MappingService.h 2012-08-29 18:20:32 UTC (rev 6962)
@@ -14,6 +14,8 @@
class FeatureTypeStyle;
}
+/// \ingroup Desktop_Module
+/// \{
class MG_DESKTOP_API MgdMappingService : public MgService
{
DECLARE_CLASSNAME(MgdMappingService)
@@ -87,5 +89,5 @@
CLASS_ID:
static const INT32 m_cls_id = MapGuide_Desktop_RenderingService_RenderingService;
};
-
+/// \}
#endif
\ No newline at end of file
Modified: branches/2.4/MgDev/Desktop/MgDesktop/Services/ProfilingService.h
===================================================================
--- branches/2.4/MgDev/Desktop/MgDesktop/Services/ProfilingService.h 2012-08-29 18:16:56 UTC (rev 6961)
+++ branches/2.4/MgDev/Desktop/MgDesktop/Services/ProfilingService.h 2012-08-29 18:20:32 UTC (rev 6962)
@@ -6,8 +6,7 @@
class MgRenderingOptions;
class MgdRenderingService;
-/// \defgroup MgdProfilingService MgdProfilingService
-/// \ingroup Profiling_Service_Module
+/// \ingroup Desktop_Module
/// \{
/// \brief
Modified: branches/2.4/MgDev/Desktop/MgDesktop/Services/Rendering/DwfVersion.h
===================================================================
--- branches/2.4/MgDev/Desktop/MgDesktop/Services/Rendering/DwfVersion.h 2012-08-29 18:16:56 UTC (rev 6961)
+++ branches/2.4/MgDev/Desktop/MgDesktop/Services/Rendering/DwfVersion.h 2012-08-29 18:20:32 UTC (rev 6962)
@@ -18,8 +18,7 @@
#ifndef DESKTOP_DWF_VERSION_H
#define DEKSTOP_DWF_VERSION_H
-/// \defgroup MgDwfVersion MgDwfVersion
-/// \ingroup Mapping_Service_Module
+/// \ingroup Desktop_Module
/// \{
/////////////////////////////////////////////////////////////////
Modified: branches/2.4/MgDev/Desktop/MgDesktop/Services/Rendering/FeatureInfoRenderer.h
===================================================================
--- branches/2.4/MgDev/Desktop/MgDesktop/Services/Rendering/FeatureInfoRenderer.h 2012-08-29 18:16:56 UTC (rev 6961)
+++ branches/2.4/MgDev/Desktop/MgDesktop/Services/Rendering/FeatureInfoRenderer.h 2012-08-29 18:20:32 UTC (rev 6962)
@@ -9,6 +9,7 @@
class KeyEncode;
class TransformMesh;
+///\cond INTERNAL
//A simple Renderer implementation for use by the QueryFeatures
//RenderingService API. Accumulates feature IDs and also attributes
//for one feature (case where a tooltip or attribute info needs to
@@ -259,5 +260,5 @@
RS_String m_test_tooltip;
RS_FeatureReader* m_feature;
};
-
+///\endcond
#endif
\ No newline at end of file
Modified: branches/2.4/MgDev/Desktop/MgDesktop/Services/Rendering/FeatureInformation.h
===================================================================
--- branches/2.4/MgDev/Desktop/MgDesktop/Services/Rendering/FeatureInformation.h 2012-08-29 18:16:56 UTC (rev 6961)
+++ branches/2.4/MgDev/Desktop/MgDesktop/Services/Rendering/FeatureInformation.h 2012-08-29 18:20:32 UTC (rev 6962)
@@ -18,15 +18,12 @@
#ifndef _MG_FEATUREINFORMATION_H_
#define _MG_FEATUREINFORMATION_H_
-/// \defgroup MgFeatureInformation MgFeatureInformation
-/// \ingroup Common_Module
-/// \{
-
class MgdFeatureInformation;
template class MG_DESKTOP_API Ptr<MgdFeatureInformation>;
class MgSelection;
-
+/// \ingroup Desktop_Module
+/// \{
///////////////////////////////////////////////////////////
/// \brief
/// Information about features.
Modified: branches/2.4/MgDev/Desktop/MgDesktop/Services/Rendering/Layout.h
===================================================================
--- branches/2.4/MgDev/Desktop/MgDesktop/Services/Rendering/Layout.h 2012-08-29 18:16:56 UTC (rev 6961)
+++ branches/2.4/MgDev/Desktop/MgDesktop/Services/Rendering/Layout.h 2012-08-29 18:20:32 UTC (rev 6962)
@@ -20,10 +20,8 @@
#include "UnitType.h"
-/// \defgroup MgLayout MgLayout
-/// \ingroup Mapping_Service_Module
+/// \ingroup Desktop_Module
/// \{
-
class MgResourceIdentifier;
////////////////////////////////////////////////////////////
Modified: branches/2.4/MgDev/Desktop/MgDesktop/Services/Rendering/MapPlot.h
===================================================================
--- branches/2.4/MgDev/Desktop/MgDesktop/Services/Rendering/MapPlot.h 2012-08-29 18:16:56 UTC (rev 6961)
+++ branches/2.4/MgDev/Desktop/MgDesktop/Services/Rendering/MapPlot.h 2012-08-29 18:20:32 UTC (rev 6962)
@@ -15,10 +15,6 @@
// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
//
-/// \defgroup MgdMapPlot MgdMapPlot
-/// \ingroup Mapping_Service_Module
-/// \{
-
#ifndef DESKTOP_MAP_PLOT_H_
#define DESKTOP_MAP_PLOT_H_
@@ -26,7 +22,8 @@
class MgdLayer;
class MgPlotSpecification;
class MgLayout;
-
+/// \ingroup Desktop_Module
+/// \{
/////////////////////////////////////////////////////////////////
/// \brief
/// The MgdMapPlot class allows the developer to specify the map,
Modified: branches/2.4/MgDev/Desktop/MgDesktop/Services/Rendering/MapPlotCollection.h
===================================================================
--- branches/2.4/MgDev/Desktop/MgDesktop/Services/Rendering/MapPlotCollection.h 2012-08-29 18:16:56 UTC (rev 6961)
+++ branches/2.4/MgDev/Desktop/MgDesktop/Services/Rendering/MapPlotCollection.h 2012-08-29 18:20:32 UTC (rev 6962)
@@ -15,10 +15,6 @@
// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
//
-/// \defgroup MgMapPlotCollection MgMapPlotCollection
-/// \ingroup Mapping_Service_Module
-/// \{
-
#ifndef DESKTOP_MAP_PLOT_COLLECTION_H_
#define DESKTOP_MAP_PLOT_COLLECTION_H_
@@ -26,7 +22,8 @@
template class MG_DESKTOP_API Ptr<MgMapPlotCollection>;
class MgMapPlot;
-
+/// \ingroup Desktop_Module
+/// \{
/////////////////////////////////////////////////////////////////
/// \brief
/// Manipulates collections of MgMapPlot objects.
Modified: branches/2.4/MgDev/Desktop/MgDesktop/Services/Rendering/MapPlotInstruction.h
===================================================================
--- branches/2.4/MgDev/Desktop/MgDesktop/Services/Rendering/MapPlotInstruction.h 2012-08-29 18:16:56 UTC (rev 6961)
+++ branches/2.4/MgDev/Desktop/MgDesktop/Services/Rendering/MapPlotInstruction.h 2012-08-29 18:20:32 UTC (rev 6962)
@@ -18,10 +18,8 @@
#ifndef DESKTOP_MAPPLOT_INSTRUCTION_H
#define DESKTOP_MAPPLOT_INSTRUCTION_H
-/// \defgroup MgMapPlotInstruction MgMapPlotInstruction
-/// \ingroup Mapping_Service_Module
+/// \ingroup Desktop_Module
/// \{
-
///////////////////////////////////////////////////////////////////////////////
/// \brief
/// MgMapPlotInstruction defines enumerated values used to indicate whether the plot
Modified: branches/2.4/MgDev/Desktop/MgDesktop/Services/Rendering/PlotSpecification.h
===================================================================
--- branches/2.4/MgDev/Desktop/MgDesktop/Services/Rendering/PlotSpecification.h 2012-08-29 18:16:56 UTC (rev 6961)
+++ branches/2.4/MgDev/Desktop/MgDesktop/Services/Rendering/PlotSpecification.h 2012-08-29 18:20:32 UTC (rev 6962)
@@ -20,10 +20,8 @@
#include "MgDesktop.h"
-/// \defgroup MgPlotSpecification MgPlotSpecification
-/// \ingroup Mapping_Service_Module
+/// \ingroup Desktop_Module
/// \{
-
////////////////////////////////////////////////////////////
/// \brief
/// Specifies the size and format of the \link ePlot ePlot \endlink
Modified: branches/2.4/MgDev/Desktop/MgDesktop/Services/Rendering/RenderingOptions.h
===================================================================
--- branches/2.4/MgDev/Desktop/MgDesktop/Services/Rendering/RenderingOptions.h 2012-08-29 18:16:56 UTC (rev 6961)
+++ branches/2.4/MgDev/Desktop/MgDesktop/Services/Rendering/RenderingOptions.h 2012-08-29 18:20:32 UTC (rev 6962)
@@ -3,8 +3,7 @@
#include "MgDesktop.h"
-/// \defgroup MgRenderingOptions MgRenderingOptions
-/// \ingroup Rendering_Service_Module
+/// \ingroup Desktop_Module
/// \{
///////////////////////////////////////////////////////////////////////////////
Modified: branches/2.4/MgDev/Desktop/MgDesktop/Services/Rendering/UnitType.h
===================================================================
--- branches/2.4/MgDev/Desktop/MgDesktop/Services/Rendering/UnitType.h 2012-08-29 18:16:56 UTC (rev 6961)
+++ branches/2.4/MgDev/Desktop/MgDesktop/Services/Rendering/UnitType.h 2012-08-29 18:20:32 UTC (rev 6962)
@@ -37,8 +37,7 @@
};
-/// \defgroup MgPageUnitsType MgPageUnitsType
-/// \ingroup Mapping_Service_Module
+/// \ingroup Desktop_Module
/// \{
/////////////////////////////////////////////////////////////////
@@ -65,10 +64,8 @@
/// \}
-/// \defgroup MgCoordinateSpace MgCoordinateSpace
-/// \ingroup Mapping_Service_Module
+/// \ingroup Desktop_Module
/// \{
-
///////////////////////////////////////////////////////////////////////////////
/// \brief
/// Specifies the coordinate space for feature geometry returned from QueryFeatures.
Modified: branches/2.4/MgDev/Desktop/MgDesktop/Services/RenderingService.h
===================================================================
--- branches/2.4/MgDev/Desktop/MgDesktop/Services/RenderingService.h 2012-08-29 18:16:56 UTC (rev 6961)
+++ branches/2.4/MgDev/Desktop/MgDesktop/Services/RenderingService.h 2012-08-29 18:20:32 UTC (rev 6962)
@@ -22,7 +22,8 @@
//NOTE: Despite MgdRenderingService not defined in PlatformBase, we don't want a naming collision
//if this library and MapGuideCommon happend to be linked together
-
+/// \ingroup Desktop_Module
+/// \{
class MG_DESKTOP_API MgdRenderingService : public MgService
{
DECLARE_CLASSNAME(MgdRenderingService)
@@ -301,5 +302,5 @@
CLASS_ID:
static const INT32 m_cls_id = MapGuide_Desktop_MappingService_MappingService;
};
-
+/// \}
#endif
\ No newline at end of file
Modified: branches/2.4/MgDev/Desktop/MgDesktop/Services/Resource/UnmanagedDataType.h
===================================================================
--- branches/2.4/MgDev/Desktop/MgDesktop/Services/Resource/UnmanagedDataType.h 2012-08-29 18:16:56 UTC (rev 6961)
+++ branches/2.4/MgDev/Desktop/MgDesktop/Services/Resource/UnmanagedDataType.h 2012-08-29 18:20:32 UTC (rev 6962)
@@ -1,6 +1,7 @@
#ifndef DESKTOP_UNMANAGED_DATA_TYPE_H
#define DESKTOP_UNMANAGED_DATA_TYPE_H
-
+/// \ingroup Desktop_Module
+/// \{
class MG_DESKTOP_API MgUnmanagedDataType
{
PUBLISHED_API:
@@ -16,5 +17,5 @@
/// Both Folders and Files
static const STRING Both; /// \if INTERNAL value("Both") \endif
};
-
+/// \}
#endif
\ No newline at end of file
Modified: branches/2.4/MgDev/Desktop/MgDesktop/Services/ResourceService.h
===================================================================
--- branches/2.4/MgDev/Desktop/MgDesktop/Services/ResourceService.h 2012-08-29 18:16:56 UTC (rev 6961)
+++ branches/2.4/MgDev/Desktop/MgDesktop/Services/ResourceService.h 2012-08-29 18:20:32 UTC (rev 6962)
@@ -2,7 +2,8 @@
#define DESKTOP_RESOURCE_SERVICE_H
#include "MgDesktop.h"
-
+/// \ingroup Desktop_Module
+/// \{
class MG_DESKTOP_API MgdResourceService : public MgResourceService
{
friend class MgFdoConnectionUtil;
@@ -113,5 +114,5 @@
STRING m_sessionDataPath;
STRING m_schemaPath;
};
-
+/// \}
#endif
\ No newline at end of file
Modified: branches/2.4/MgDev/Desktop/MgDesktop/Services/ScrollableFeatureReader.h
===================================================================
--- branches/2.4/MgDev/Desktop/MgDesktop/Services/ScrollableFeatureReader.h 2012-08-29 18:16:56 UTC (rev 6961)
+++ branches/2.4/MgDev/Desktop/MgDesktop/Services/ScrollableFeatureReader.h 2012-08-29 18:20:32 UTC (rev 6962)
@@ -8,7 +8,8 @@
// The MgdScrollableFeatureReader is an extension to the MgFeatureReader
// that can be traversed in the forward and backward direction (scrollable)
-
+/// \ingroup Desktop_Module
+/// \{
class MG_DESKTOP_API MgdScrollableFeatureReader : public MgdFeatureReader
{
INTERNAL_API:
@@ -43,5 +44,5 @@
private:
FdoIScrollableFeatureReader* m_scrollReader;
};
-
+/// \}
#endif
\ No newline at end of file
Modified: branches/2.4/MgDev/Desktop/MgDesktop/Services/ServiceFactory.h
===================================================================
--- branches/2.4/MgDev/Desktop/MgDesktop/Services/ServiceFactory.h 2012-08-29 18:16:56 UTC (rev 6961)
+++ branches/2.4/MgDev/Desktop/MgDesktop/Services/ServiceFactory.h 2012-08-29 18:20:32 UTC (rev 6962)
@@ -8,7 +8,8 @@
class MgdResourceService;
class MgdDrawingService;
class MgdRenderingService;
-
+/// \ingroup Desktop_Module
+/// \{
class MG_DESKTOP_API MgServiceFactory : public MgGuardDisposable
{
MG_DECL_DYNCREATE()
@@ -36,5 +37,5 @@
static STRING sm_sesDataPath;
static STRING sm_schemaPath;
};
-
+/// \}
#endif
\ No newline at end of file
Modified: branches/2.4/MgDev/Desktop/MgDesktop/Services/SqlReader.h
===================================================================
--- branches/2.4/MgDev/Desktop/MgDesktop/Services/SqlReader.h 2012-08-29 18:16:56 UTC (rev 6961)
+++ branches/2.4/MgDev/Desktop/MgDesktop/Services/SqlReader.h 2012-08-29 18:20:32 UTC (rev 6962)
@@ -5,7 +5,8 @@
class FdoISQLDataReader;
class MgFeatureConnection;
-
+/// \ingroup Desktop_Module
+/// \{
class MG_DESKTOP_API MgdSqlDataReader : public MgSqlDataReader
{
INTERNAL_API:
@@ -108,5 +109,5 @@
FdoISQLDataReader* m_reader;
Ptr<MgFeatureConnection> m_connection;
};
-
+/// \}
#endif
\ No newline at end of file
Modified: branches/2.4/MgDev/Desktop/MgDesktop/Services/TileService.h
===================================================================
--- branches/2.4/MgDev/Desktop/MgDesktop/Services/TileService.h 2012-08-29 18:16:56 UTC (rev 6961)
+++ branches/2.4/MgDev/Desktop/MgDesktop/Services/TileService.h 2012-08-29 18:20:32 UTC (rev 6962)
@@ -2,7 +2,8 @@
#define DESKTOP_TILE_SERVICE_H
#include "Tile/TileCache.h"
-
+/// \ingroup Desktop_Module
+/// \{
class MG_DESKTOP_API MgdTileService : public MgService
{
DECLARE_CLASSNAME(MgdTileService)
@@ -79,5 +80,5 @@
static INT32 sm_pollingInterval;
static INT32 sm_mapCacheSize;
};
-
+/// \}
#endif
\ No newline at end of file
Modified: branches/2.4/MgDev/Desktop/MgDesktop/Services/Transaction.h
===================================================================
--- branches/2.4/MgDev/Desktop/MgDesktop/Services/Transaction.h 2012-08-29 18:16:56 UTC (rev 6961)
+++ branches/2.4/MgDev/Desktop/MgDesktop/Services/Transaction.h 2012-08-29 18:20:32 UTC (rev 6962)
@@ -5,7 +5,8 @@
class MgFeatureConnection;
class FdoITransaction;
-
+/// \ingroup Desktop_Module
+/// \{
class MG_DESKTOP_API MgdTransaction : public MgTransaction
{
INTERNAL_API:
@@ -40,5 +41,5 @@
MgFeatureConnection* m_conn;
};
-
+/// \}
#endif
\ No newline at end of file
Added: branches/2.4/MgDev/Doc/MgDesktop_Doxyfile
===================================================================
--- branches/2.4/MgDev/Doc/MgDesktop_Doxyfile (rev 0)
+++ branches/2.4/MgDev/Doc/MgDesktop_Doxyfile 2012-08-29 18:20:32 UTC (rev 6962)
@@ -0,0 +1,360 @@
+# Doxyfile 1.8.0
+
+#---------------------------------------------------------------------------
+# Project related configuration options
+#---------------------------------------------------------------------------
+DOXYFILE_ENCODING = UTF-8
+PROJECT_NAME = "mg-desktop" "API" "Reference"
+PROJECT_NUMBER =
+PROJECT_BRIEF =
+PROJECT_LOGO =
+OUTPUT_DIRECTORY =
+CREATE_SUBDIRS = YES
+OUTPUT_LANGUAGE = English
+BRIEF_MEMBER_DESC = YES
+REPEAT_BRIEF = YES
+ABBREVIATE_BRIEF =
+ALWAYS_DETAILED_SEC = NO
+INLINE_INHERITED_MEMB = NO
+FULL_PATH_NAMES = NO
+STRIP_FROM_PATH =
+STRIP_FROM_INC_PATH =
+SHORT_NAMES = NO
+JAVADOC_AUTOBRIEF = NO
+QT_AUTOBRIEF = NO
+MULTILINE_CPP_IS_BRIEF = NO
+INHERIT_DOCS = YES
+SEPARATE_MEMBER_PAGES = YES
+TAB_SIZE = 4
+ALIASES = ProdName="mg-desktop"
+ALIASES += DevGuide="<em>MapGuide Open Source Developer's Guide</em>"
+ALIASES += note1=""
+ALIASES += note2=""
+TCL_SUBST =
+OPTIMIZE_OUTPUT_FOR_C = NO
+OPTIMIZE_OUTPUT_JAVA = NO
+OPTIMIZE_FOR_FORTRAN = NO
+OPTIMIZE_OUTPUT_VHDL = NO
+EXTENSION_MAPPING =
+MARKDOWN_SUPPORT = YES
+BUILTIN_STL_SUPPORT = NO
+CPP_CLI_SUPPORT = NO
+SIP_SUPPORT = NO
+IDL_PROPERTY_SUPPORT = NO
+DISTRIBUTE_GROUP_DOC = NO
+SUBGROUPING = YES
+INLINE_GROUPED_CLASSES = NO
+INLINE_SIMPLE_STRUCTS = NO
+TYPEDEF_HIDES_STRUCT = NO
+SYMBOL_CACHE_SIZE = 0
+LOOKUP_CACHE_SIZE = 0
+#---------------------------------------------------------------------------
+# Build related configuration options
+#---------------------------------------------------------------------------
+EXTRACT_ALL = YES
+EXTRACT_PRIVATE = NO
+EXTRACT_PACKAGE = NO
+EXTRACT_STATIC = YES
+EXTRACT_LOCAL_CLASSES = YES
+EXTRACT_LOCAL_METHODS = NO
+EXTRACT_ANON_NSPACES = NO
+HIDE_UNDOC_MEMBERS = NO
+HIDE_UNDOC_CLASSES = NO
+HIDE_FRIEND_COMPOUNDS = NO
+HIDE_IN_BODY_DOCS = NO
+INTERNAL_DOCS = NO
+CASE_SENSE_NAMES = NO
+HIDE_SCOPE_NAMES = NO
+SHOW_INCLUDE_FILES = NO
+FORCE_LOCAL_INCLUDES = NO
+INLINE_INFO = YES
+SORT_MEMBER_DOCS = YES
+SORT_BRIEF_DOCS = YES
+SORT_MEMBERS_CTORS_1ST = NO
+SORT_GROUP_NAMES = NO
+SORT_BY_SCOPE_NAME = NO
+STRICT_PROTO_MATCHING = NO
+GENERATE_TODOLIST = NO
+GENERATE_TESTLIST = NO
+GENERATE_BUGLIST = NO
+GENERATE_DEPRECATEDLIST= YES
+ENABLED_SECTIONS = DESKTOPAPI
+MAX_INITIALIZER_LINES = 30
+SHOW_USED_FILES = NO
+SHOW_DIRECTORIES = NO
+SHOW_FILES = NO
+SHOW_NAMESPACES = NO
+FILE_VERSION_FILTER =
+LAYOUT_FILE =
+CITE_BIB_FILES =
+#---------------------------------------------------------------------------
+# configuration options related to warning and progress messages
+#---------------------------------------------------------------------------
+QUIET = NO
+WARNINGS = YES
+WARN_IF_UNDOCUMENTED = YES
+WARN_IF_DOC_ERROR = YES
+WARN_NO_PARAMDOC = YES
+WARN_FORMAT = "$file:$line: $text"
+WARN_LOGFILE = MgDesktop_warn_log.txt
+#---------------------------------------------------------------------------
+# configuration options related to the input files
+#---------------------------------------------------------------------------
+INPUT = external_topics \
+ group_and_page_definitions \
+ ../Common/Foundation \
+ ../Common/Geometry \
+ ../Common/PlatformBase \
+ ../Desktop/MgDesktop
+INPUT_ENCODING = UTF-8
+FILE_PATTERNS = *.h
+RECURSIVE = YES
+EXCLUDE =
+EXCLUDE_SYMLINKS = NO
+EXCLUDE_PATTERNS = */Buffer/BorderWalker.h \
+ */Buffer/buffer.h \
+ */Buffer/bufraloc.h \
+ */Buffer/bufrsort.h \
+ */Buffer/bufrutil.h \
+ */Buffer/DumpFFGF.h \
+ */Buffer/eventarr.h \
+ */Buffer/eventint.h \
+ */Buffer/FloatTransform.h \
+ */Buffer/GreatCircleBufferUtil.h \
+ */Buffer/interlst.h \
+ */Buffer/interprc.h \
+ */Buffer/LatLonBorderWalker.h \
+ */Buffer/oarray.h \
+ */Buffer/oextent.h \
+ */Buffer/ogeomtry.h \
+ */Buffer/olinep.h \
+ */Buffer/oobject.h \
+ */Buffer/opline.h \
+ */Buffer/opoint.h \
+ */Buffer/opolygnp.h \
+ */Buffer/opolygon.h \
+ */Buffer/oppolygn.h \
+ */Buffer/oppolyln.h \
+ */Buffer/opsprimitive.h \
+ */Buffer/orpplygn.h \
+ */Buffer/ortree.h \
+ */Buffer/planeswp.h \
+ */Buffer/plgnbufr.h \
+ */Buffer/plinbufr.h \
+ */Buffer/pobjbufr.h \
+ */Buffer/ppgunion.h \
+ */Buffer/progcbck.h \
+ */Buffer/sedgaloc.h \
+ */Buffer/sweepedg.h \
+ */Buffer/tuplearr.h \
+ */Buffer/vertaloc.h \
+ */Buffer/wedgaloc.h \
+ */Buffer/wedgearr.h \
+ */Buffer/wingedge.h \
+ */Buffer/worklist.h \
+ */Buffer/xordtree.h \
+ */Geometry/Parse/LexAwkt.h \
+ */Geometry/Parse/yyAwkt.h \
+ */Geometry/Parse/Array.h \
+ */Geometry/Parse/ParseAwkt.h \
+ */Geometry/GeometryConsoleTest/* \
+ */Geometry/Spatial/* \
+ */MapLayer/Watermark.h \
+ */System/CommonDefs.h \
+ */System/Ptr.h \
+ */System/FileUtil.h \
+ */System/Util.h \
+ */System/CryptographyManager.h \
+ */PrintLayoutService/* \
+ */Data/Point3D.h \
+ */Data/Size2D.h \
+ */Data/Vector3D.h \
+ */Data/Margin.h \
+ */Data/SerializableCollection.h \
+ */.svn
+EXCLUDE_SYMBOLS =
+EXAMPLE_PATH = headers_and_footers
+EXAMPLE_PATTERNS = *
+EXAMPLE_RECURSIVE = YES
+IMAGE_PATH = other_graphics
+INPUT_FILTER =
+FILTER_PATTERNS =
+FILTER_SOURCE_FILES = NO
+FILTER_SOURCE_PATTERNS =
+#---------------------------------------------------------------------------
+# configuration options related to source browsing
+#---------------------------------------------------------------------------
+SOURCE_BROWSER = NO
+INLINE_SOURCES = NO
+STRIP_CODE_COMMENTS = NO
+REFERENCED_BY_RELATION = YES
+REFERENCES_RELATION = YES
+REFERENCES_LINK_SOURCE = YES
+USE_HTAGS = NO
+VERBATIM_HEADERS = NO
+#---------------------------------------------------------------------------
+# configuration options related to the alphabetical class index
+#---------------------------------------------------------------------------
+ALPHABETICAL_INDEX = YES
+COLS_IN_ALPHA_INDEX = 5
+IGNORE_PREFIX =
+#---------------------------------------------------------------------------
+# configuration options related to the HTML output
+#---------------------------------------------------------------------------
+GENERATE_HTML = YES
+HTML_OUTPUT = MgDesktop_WebAPIReference
+HTML_FILE_EXTENSION = .htm
+HTML_HEADER = headers_and_footers/header.html
+HTML_FOOTER = headers_and_footers/footer.html
+HTML_STYLESHEET = css/mg_open_source.css
+#HTML_HEADER =
+#HTML_FOOTER =
+#HTML_STYLESHEET =
+HTML_EXTRA_FILES =
+HTML_COLORSTYLE_HUE = 220
+HTML_COLORSTYLE_SAT = 100
+HTML_COLORSTYLE_GAMMA = 80
+HTML_TIMESTAMP = YES
+HTML_ALIGN_MEMBERS = YES
+HTML_DYNAMIC_SECTIONS = YES
+GENERATE_DOCSET = NO
+GENERATE_HTMLHELP = NO
+CHM_FILE =
+HHC_LOCATION =
+GENERATE_CHI = NO
+CHM_INDEX_ENCODING =
+BINARY_TOC = NO
+TOC_EXPAND = NO
+GENERATE_QHP = NO
+QCH_FILE =
+QHP_NAMESPACE = org.doxygen.Project
+QHP_VIRTUAL_FOLDER = doc
+QHP_CUST_FILTER_NAME =
+QHP_CUST_FILTER_ATTRS =
+QHP_SECT_FILTER_ATTRS =
+QHG_LOCATION =
+GENERATE_ECLIPSEHELP = NO
+ECLIPSE_DOC_ID = org.doxygen.Project
+DISABLE_INDEX = NO
+GENERATE_TREEVIEW = YES
+ENUM_VALUES_PER_LINE = 4
+USE_INLINE_TREES = NO
+TREEVIEW_WIDTH = 250
+EXT_LINKS_IN_WINDOW = NO
+FORMULA_FONTSIZE = 10
+FORMULA_TRANSPARENT = YES
+USE_MATHJAX = NO
+MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
+MATHJAX_EXTENSIONS =
+SEARCHENGINE = YES
+SERVER_BASED_SEARCH = NO
+#---------------------------------------------------------------------------
+# configuration options related to the LaTeX output
+#---------------------------------------------------------------------------
+GENERATE_LATEX = NO
+LATEX_OUTPUT = latex
+LATEX_CMD_NAME = latex
+MAKEINDEX_CMD_NAME = makeindex
+COMPACT_LATEX = NO
+PAPER_TYPE = a4
+EXTRA_PACKAGES =
+LATEX_HEADER =
+LATEX_FOOTER =
+PDF_HYPERLINKS = YES
+USE_PDFLATEX = YES
+LATEX_BATCHMODE = NO
+LATEX_HIDE_INDICES = NO
+LATEX_SOURCE_CODE = NO
+LATEX_BIB_STYLE = plain
+#---------------------------------------------------------------------------
+# configuration options related to the RTF output
+#---------------------------------------------------------------------------
+GENERATE_RTF = NO
+RTF_OUTPUT = rtf
+COMPACT_RTF = NO
+RTF_HYPERLINKS = NO
+RTF_STYLESHEET_FILE =
+RTF_EXTENSIONS_FILE =
+#---------------------------------------------------------------------------
+# configuration options related to the man page output
+#---------------------------------------------------------------------------
+GENERATE_MAN = NO
+MAN_OUTPUT = man
+MAN_EXTENSION = .3
+MAN_LINKS = NO
+#---------------------------------------------------------------------------
+# configuration options related to the XML output
+#---------------------------------------------------------------------------
+GENERATE_XML = NO
+XML_OUTPUT = xml
+XML_SCHEMA =
+XML_DTD =
+XML_PROGRAMLISTING = YES
+#---------------------------------------------------------------------------
+# configuration options for the AutoGen Definitions output
+#---------------------------------------------------------------------------
+GENERATE_AUTOGEN_DEF = NO
+#---------------------------------------------------------------------------
+# configuration options related to the Perl module output
+#---------------------------------------------------------------------------
+GENERATE_PERLMOD = NO
+PERLMOD_LATEX = NO
+PERLMOD_PRETTY = YES
+PERLMOD_MAKEVAR_PREFIX =
+#---------------------------------------------------------------------------
+# Configuration options related to the preprocessor
+#---------------------------------------------------------------------------
+ENABLE_PREPROCESSING = YES
+MACRO_EXPANSION = YES
+EXPAND_ONLY_PREDEF = NO
+SEARCH_INCLUDES = YES
+INCLUDE_PATH =
+INCLUDE_FILE_PATTERNS =
+PREDEFINED = INTERNAL_API=private \
+ EXTERNAL_API=private \
+ PUBLISHED_API=public \
+ protected=private
+EXPAND_AS_DEFINED =
+SKIP_FUNCTION_MACROS = YES
+#---------------------------------------------------------------------------
+# Configuration::additions related to external references
+#---------------------------------------------------------------------------
+TAGFILES =
+GENERATE_TAGFILE =
+ALLEXTERNALS = NO
+EXTERNAL_GROUPS = NO
+PERL_PATH = /usr/bin/perl
+#---------------------------------------------------------------------------
+# Configuration options related to the dot tool
+#---------------------------------------------------------------------------
+CLASS_DIAGRAMS = NO
+MSCGEN_PATH =
+HIDE_UNDOC_RELATIONS = YES
+HAVE_DOT = YES
+DOT_NUM_THREADS = 0
+DOT_FONTNAME = Helvetica
+DOT_FONTSIZE = 10
+DOT_FONTPATH =
+CLASS_GRAPH = YES
+COLLABORATION_GRAPH = NO
+GROUP_GRAPHS = NO
+UML_LOOK = NO
+UML_LIMIT_NUM_FIELDS = 10
+TEMPLATE_RELATIONS = NO
+INCLUDE_GRAPH = YES
+INCLUDED_BY_GRAPH = YES
+CALL_GRAPH = NO
+CALLER_GRAPH = NO
+GRAPHICAL_HIERARCHY = YES
+DIRECTORY_GRAPH = YES
+DOT_IMAGE_FORMAT = png
+INTERACTIVE_SVG = NO
+DOT_PATH =
+DOTFILE_DIRS =
+MSCFILE_DIRS =
+DOT_GRAPH_MAX_NODES = 50
+MAX_DOT_GRAPH_DEPTH = 1000
+DOT_TRANSPARENT = NO
+DOT_MULTI_TARGETS = NO
+GENERATE_LEGEND = YES
+DOT_CLEANUP = YES
Added: branches/2.4/MgDev/Doc/MgDesktop_run_doxygen.bat
===================================================================
--- branches/2.4/MgDev/Doc/MgDesktop_run_doxygen.bat (rev 0)
+++ branches/2.4/MgDev/Doc/MgDesktop_run_doxygen.bat 2012-08-29 18:20:32 UTC (rev 6962)
@@ -0,0 +1,32 @@
+ at echo off
+
+:::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
+:: Copy the doxygen.css file
+
+echo Copying doxygen.css ...
+
+if not exist MgDesktop_WebAPIReference\ mkdir MgDesktop_WebAPIReference\
+copy css\doxygen.css MgDesktop_WebAPIReference
+
+:::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
+:: Copy the XML schemas
+
+if not exist MgDesktop_WebAPIReference\xml_schemas mkdir MgDesktop_WebAPIReference\xml_schemas\
+xcopy /s /y "xml_schemas\*" MgDesktop_WebAPIReference\xml_schemas\
+
+:::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
+:: Run Doxygen
+
+echo Running Doxygen ...
+doxygen MgDesktop_Doxyfile > MgDesktop_run_log.txt
+echo Doxygen generation is complete. The error log is in 'MgDesktop_warn_log.txt'.
+
+:::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
+;: Post Process
+
+echo Running the post processor ...
+perl -w PostProcessor/post_process.MgDesktop.pl
+
+:::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
+echo All done.
+
Added: branches/2.4/MgDev/Doc/PostProcessor/post_process.MgDesktop.pl
===================================================================
--- branches/2.4/MgDev/Doc/PostProcessor/post_process.MgDesktop.pl (rev 0)
+++ branches/2.4/MgDev/Doc/PostProcessor/post_process.MgDesktop.pl 2012-08-29 18:20:32 UTC (rev 6962)
@@ -0,0 +1,112 @@
+#!/usr/bin/perl -w
+###################################################################
+# post_process.MgOpenSource.pl
+# ============================
+#
+# Purpose:
+# Does some post-processing of the HTML files produced
+# by Doxygen, to fix things that we cannot configure
+# through Doxygen.
+# See PostProcess.pm for details.
+#
+# Usage:
+# 1) Alter the file paths etc. below (in the Parameters section) if necessary.
+# 2) Call the script like this (from the HTML directory):
+# perl -w "PostProcessor\post_process.MgOpenSource.pl"
+#
+#
+# History:
+# v 1.0 - Written by Philip Sharman, 2008.02.11
+# v 1.1 - Removed $SCRIPTS_DIRECTORY. Now use use File::Bin to determine where the
+# script lives. PHS, 2008.02.14
+# v 1.2 - Changed to not use any external Perl modules, to make it easier to
+# distribute. Also moved the main calling routine back to here and out
+# of PostProcessor.pm. PHS, 2008.02.20
+# v 1.3 - Added ROOT, call to 'change_root', and call to 'change_namespace()'.
+# PHS, 2008.02.24
+#############################################################
+package PostProcessor;
+use lib 'PostProcessor'; # Look in the PostProcessor directory for PostProcessor.pm (assuming we are called from the HTML parent directory).
+use PostProcessor;
+
+use strict;
+use warnings;
+use English;
+use FindBin;
+use Fatal qw(open close); # See Perl Best Practices, page 278.
+
+# Flush output to screen after every "print" so we can see what it going on immediately
+# See Perl Best Practices, page 226.
+use IO::Handle;
+*STDOUT->autoflush();
+
+
+###################################################################
+### Global Variables
+###################################################################
+# These must be defined this way so that 'PostProcessor.pm' can use them.
+use vars qw($DIRECTORY_SEPARATOR $INPUT_DIRECTORY $TITLE $ROOT $TRUE $FALSE $VERBOSE);
+$TRUE = (1==1);
+$FALSE = (1==0);
+# (Sadly, there seems to be no way to use Readonly with variables we want to share with a module.)
+
+
+###################################################################
+### Get information about the script's environment
+###################################################################
+# Set the directory separator appropriate for this platform
+if ($OSNAME eq 'MSWin32')
+{
+ $DIRECTORY_SEPARATOR = '\\';
+}
+elsif ($OSNAME eq 'linux')
+{
+ $DIRECTORY_SEPARATOR = '/';
+}
+else
+{
+ # We are confused
+ die "Fatal Error. This script does not know how to handle the case where \$OSNAME = '$OSNAME'.\n";
+}
+
+
+
+###################################################################
+### Parameters
+###################################################################
+# Change these as necessary
+
+# This script will examine all the .htm files in this directory (and its subdirectories)
+$INPUT_DIRECTORY = '..' . $DIRECTORY_SEPARATOR . 'MgDesktop_WebAPIReference';
+#$INPUT_DIRECTORY = 'TEST_POST_PROCESSING_INPUT'; # For testing
+
+# The title to be shown in the web browser
+$TITLE = 'MapGuide Web API Reference';
+
+# The name for the top node in the TOC
+$ROOT = 'MapGuide Web API Reference';
+
+# Set this to $TRUE if you want more verbose information about what the script is doing
+#$VERBOSE = $TRUE;
+$VERBOSE = $FALSE;
+
+
+###################################################################
+# Do it all
+my $start_time = time();
+$INPUT_DIRECTORY = change_relative_path_to_absolute($INPUT_DIRECTORY);
+print "Post processing '$INPUT_DIRECTORY' ... \n\n";
+
+# Do it
+show_global_variables(); # (for debugging)
+#delete_file_list();
+remove_SWIG_commands_from_directory($INPUT_DIRECTORY);
+#change_title();
+fix_links_in_directory($INPUT_DIRECTORY);
+#change_root();
+#remove_namespace();
+
+# All done
+print "\nPost processing is complete. (Time taken = ", convert_seconds_to_hms_string((time() - $start_time)) , ".)\n";
+
+###################################################################
Added: branches/2.4/MgDev/Doc/external_topics/Desktop_Introduction.h
===================================================================
--- branches/2.4/MgDev/Doc/external_topics/Desktop_Introduction.h (rev 0)
+++ branches/2.4/MgDev/Doc/external_topics/Desktop_Introduction.h 2012-08-29 18:20:32 UTC (rev 6962)
@@ -0,0 +1,7 @@
+/**
+\addtogroup Desktop_Module
+<p>
+ The Resource Service enables you to manipulate repositories
+ and resources.
+</p>
+**/
More information about the mapguide-commits
mailing list