Changes between Version 1 and Version 2 of MapGuideRfc158

Timestamp:

Apr 12, 2017, 9:14:56 AM (7 years ago)

Author:

jng

Comment:

--

MapGuideRfc158

@@ -65 +65 @@
 
 {{{
+/////////////////////////////////////////////////////////////////////////////////////////////////////////
+/// \brief
+/// A helper class to output GeoJSON from feature readers
+///
 class MG_PLATFORMBASE_API MgGeoJsonWriter : public MgGuardDisposable
 {
 PUBLISHED_API:
+    //////////////////////////////////////////////////////////////////
+    /// \brief
+    /// Constructs a MgGeoJsonWriter object
+    ///
+    /// <!-- Syntax in .Net, Java, and PHP -->
+    /// \htmlinclude DotNetSyntaxTop.html
+    /// MgGeoJsonWriter();
+    /// \htmlinclude SyntaxBottom.html
+    /// \htmlinclude JavaSyntaxTop.html
+    /// MgGeoJsonWriter();
+    /// \htmlinclude SyntaxBottom.html
+    /// \htmlinclude PHPSyntaxTop.html
+    /// MgGeoJsonWriter();
+    /// \htmlinclude SyntaxBottom.html
+    ///
     MgGeoJsonWriter();
 
+    //////////////////////////////////////////////////////////////////
+    /// \brief
+    /// Converts the current feature in the given feature reader to GeoJSON
+    ///
+    /// \remarks
+    /// The id and geometry properties are inferred from the class definition returned by the feature reader
+    ///
+    /// <!-- Syntax in .Net, Java, and PHP -->
+    /// \htmlinclude DotNetSyntaxTop.html
+    /// string FeatureToGeoJson(MgFeatureReader featureReader, MgTransform transform);
+    /// \htmlinclude SyntaxBottom.html
+    /// \htmlinclude JavaSyntaxTop.html
+    /// String FeatureToGeoJson(MgFeatureReader featureReader, MgTransform transform);
+    /// \htmlinclude SyntaxBottom.html
+    /// \htmlinclude PHPSyntaxTop.html
+    /// string FeatureToGeoJson(MgFeatureReader featureReader, MgTransform transform);
+    /// \htmlinclude SyntaxBottom.html
+    ///
+    /// \param featureReader (MgFeatureReader)
+    /// The feature reader
+    ///
+    /// \param transform (MgTransform)
+    /// An optional transform
+    ///
+    /// \return
+    /// Returns the GeoJSON output as a string.
+    ///
     STRING FeatureToGeoJson(MgFeatureReader* featureReader, MgTransform* transform);
 
+    //////////////////////////////////////////////////////////////////
+    /// \brief
+    /// Converts the current feature in the given feature reader to GeoJSON
+    ///
+    /// <!-- Syntax in .Net, Java, and PHP -->
+    /// \htmlinclude DotNetSyntaxTop.html
+    /// string FeatureToGeoJson(MgFeatureReader featureReader, MgTransform transform, string idPropertyName, string geomPropName);
+    /// \htmlinclude SyntaxBottom.html
+    /// \htmlinclude JavaSyntaxTop.html
+    /// String FeatureToGeoJson(MgFeatureReader featureReader, MgTransform transform, String idPropertyName, String geomPropName);
+    /// \htmlinclude SyntaxBottom.html
+    /// \htmlinclude PHPSyntaxTop.html
+    /// string FeatureToGeoJson(MgFeatureReader featureReader, MgTransform transform, string idPropertyName, string geomPropName);
+    /// \htmlinclude SyntaxBottom.html
+    ///
+    /// \param featureReader (MgFeatureReader)
+    /// The feature reader
+    ///
+    /// \param transform (MgTransform)
+    /// An optional transform
+    ///
+    /// \param idPropertyName (String/string)
+    /// The name of the id property. The value of the property specified will be written to the top-level "id" property of the GeoJSON
+    ///
+    /// \param geomPropName (String/string)
+    /// The name of the geometry property. The value of the property specified will be written to the top-level "geometry" property
+    /// of the GeoJSON. If this property is not specified, no geometry is written.
+    ///
+    /// \return
+    /// Returns the GeoJSON output as a string.
+    ///
     STRING FeatureToGeoJson(MgReader* reader, MgTransform* transform, CREFSTRING idPropertyName, CREFSTRING geomPropName);
 };
 }}}
 
-The {{{SELECTFEATURES}}} operation with {{{CLEAN=1}}} will use this class to output the response as GeoJSON
+The {{{SELECTFEATURES}}} operation with {{{CLEAN=1}}} will use this class to output the response as GeoJSON.
+
+This class is also available to the public API for MapGuide applications to use.
 
 == Implications ==