[mapguide-commits] r8141 - branches/2.6/MgDev/Common/MapGuideCommon/Services

[svn_mapguide at osgeo.org]

Author: jng
Date: 2014-05-21 00:07:10 -0700 (Wed, 21 May 2014)
New Revision: 8141

Modified:
   branches/2.6/MgDev/Common/MapGuideCommon/Services/RenderingService.h
Log:
Fix up the API documentation for MgRenderingService::RenderTile. This method is just a tile rendering primitive. No tile caching is done by this method.

Modified: branches/2.6/MgDev/Common/MapGuideCommon/Services/RenderingService.h
===================================================================
--- branches/2.6/MgDev/Common/MapGuideCommon/Services/RenderingService.h	2014-05-21 04:49:32 UTC (rev 8140)
+++ branches/2.6/MgDev/Common/MapGuideCommon/Services/RenderingService.h	2014-05-21 07:07:10 UTC (rev 8141)
@@ -39,10 +39,13 @@
 
     /////////////////////////////////////////////////////////////////
     /// \brief
-    /// Returns the specified base map tile for the given map.  If a cached tile
-    /// image exists it will return it, otherwise the tile is rendered and added
-    /// to the cache.
+    /// Returns the specified base map tile for the given map.
     ///
+    /// \remarks
+    /// This method only renders the given tile. No tile caching is performed
+    /// by this method. To render and cache the tile, use the 
+    /// \link MgTileService::GetTile GetTile \endlink method instead
+    ///
     /// \param map
     /// Input
     /// map object containing current state of map.