[Commits] r2372 - core/trunk/geoext/lib/GeoExt/widgets/tree

[commits at geoext.org]

Author: ahocevar
Date: 2010-09-21 08:14:37 +0200 (Tue, 21 Sep 2010)
New Revision: 2372

Modified:
   core/trunk/geoext/lib/GeoExt/widgets/tree/WMSCapabilitiesLoader.js
Log:
Better documentation. Non-functional change.


Modified: core/trunk/geoext/lib/GeoExt/widgets/tree/WMSCapabilitiesLoader.js
===================================================================
--- core/trunk/geoext/lib/GeoExt/widgets/tree/WMSCapabilitiesLoader.js	2010-09-20 23:51:53 UTC (rev 2371)
+++ core/trunk/geoext/lib/GeoExt/widgets/tree/WMSCapabilitiesLoader.js	2010-09-21 06:14:37 UTC (rev 2372)
@@ -17,7 +17,11 @@
 /** api: constructor
  *  .. class:: WMSCapabilitiesLoader
  *
- *      A loader that will load all layers of a Web Map Service (WMS).
+ *      A loader that will load create a tree of all layers of a Web Map
+ *      Service (WMS), maintaining its tree structure. Nodes created by this
+ *      loader are instances of ``Ext.tree.TreeNode``. If the WMS Capabilities
+ *      advertise a name for a layer, an OpenLayers.Layer.WMS instance will
+ *      be set on the node in its ``layer`` attribute.
  */
 GeoExt.tree.WMSCapabilitiesLoader = function(config) {
     Ext.apply(this, config);