[Commits] r1380 - core/trunk/geoext/lib/GeoExt/widgets

[commits at geoext.org]

Author: ahocevar
Date: 2009-10-05 14:32:54 +0200 (Mon, 05 Oct 2009)
New Revision: 1380

Modified:
   core/trunk/geoext/lib/GeoExt/widgets/LegendWMS.js
Log:
provide better documentation on the source of the WMS layer image. Non-functional change.

Modified: core/trunk/geoext/lib/GeoExt/widgets/LegendWMS.js
===================================================================
--- core/trunk/geoext/lib/GeoExt/widgets/LegendWMS.js	2009-10-05 08:21:40 UTC (rev 1379)
+++ core/trunk/geoext/lib/GeoExt/widgets/LegendWMS.js	2009-10-05 12:32:54 UTC (rev 1380)
@@ -20,7 +20,10 @@
 /** api: constructor
  *  .. class:: LegendWMS(config)
  *
- *  Show a legend image for a WMS layer.
+ *  Show a legend image for a WMS layer. The image can be read from the styles
+ *  field of a layer record (if the record comes e.g. from a
+ *  :class:`GeoExt.data.WMSCapabilitiesReader`). If not provided, a
+ *  GetLegendGraphic request will be issued to retrieve the image.
  */
 GeoExt.LegendWMS = Ext.extend(Ext.Panel, {
 
@@ -52,7 +55,9 @@
     
     /** api: config[record]
      *  ``Ext.data.Record``
-     *  optional record containing the layer 
+     *  Optional record containing the layer. If provided, and if the record
+     *  has a styles property, the legend image associated with the layer's
+     *  style will be used.
      */
     record: null,