[Commits] r921 - core/trunk/geoext/lib/GeoExt/data

[commits at geoext.org]

Author: tschaub
Date: 2009-05-29 23:44:47 +0200 (Fri, 29 May 2009)
New Revision: 921

Modified:
   core/trunk/geoext/lib/GeoExt/data/ScaleStore.js
   core/trunk/geoext/lib/GeoExt/data/WMSCapabilitiesStore.js
Log:
Docs for WMSCapabilitiesStore.

Modified: core/trunk/geoext/lib/GeoExt/data/ScaleStore.js
===================================================================
--- core/trunk/geoext/lib/GeoExt/data/ScaleStore.js	2009-05-29 21:38:50 UTC (rev 920)
+++ core/trunk/geoext/lib/GeoExt/data/ScaleStore.js	2009-05-29 21:44:47 UTC (rev 921)
@@ -12,14 +12,6 @@
  */
 Ext.namespace("GeoExt.data");
 
-/**
- *  Class: GeoExt.data.ScaleStore
- *  This store maintains a list of available zoom levels, optionally keeping it synchronized with 
- *  a Map or MapPanel instance.   The entries in the list have the following fields: 
- *  zoom - the number of the zoom level
- *  scale - the scale denominator for the zoom level
- *  resolution - the map resolution when the zoom level is active.
- */
 /** api: constructor
  *  .. class:: ScaleStore
  *

Modified: core/trunk/geoext/lib/GeoExt/data/WMSCapabilitiesStore.js
===================================================================
--- core/trunk/geoext/lib/GeoExt/data/WMSCapabilitiesStore.js	2009-05-29 21:38:50 UTC (rev 920)
+++ core/trunk/geoext/lib/GeoExt/data/WMSCapabilitiesStore.js	2009-05-29 21:44:47 UTC (rev 921)
@@ -6,36 +6,39 @@
  * @include GeoExt/data/WMSCapabilitiesReader.js
  */
 
+/** api: (define)
+ *  module = GeoExt.data
+ *  class = WMSCapabilitiesStore
+ *  base_link = `Ext.data.DataStore <http://extjs.com/deploy/dev/docs/?class=Ext.data.DataStore>`_
+ */
 Ext.namespace("GeoExt.data");
-/**
- * Class: GeoExt.data.WMSCapabilitiesStore
- * Small helper class to make creating stores for remote WMS layer data easier.
- *     WMSCapabilitiesStore is pre-configured with a built-in
- *     {Ext.data.HttpProxy} and {GeoExt.data.WMSCapabilitiesReader}.  The
- *     HttpProxy is configured to allow caching (disableCaching: false) and uses
- *     GET.  If you require some other proxy/reader combination then you'll have
- *     to configure this with your own proxy or create a basic
- *     GeoExt.data.LayerStore and configure as needed.
- *
- * Extends:
- *  - GeoExt.data.Store
+
+/** api: constructor
+ *  .. class:: WMSCapabilitiesStore
+ *  
+ *      Small helper class to make creating stores for remote WMS layer data
+ *      easier.  The store is pre-configured with a built-in
+ *      ``Ext.data.HttpProxy`` and :class:`GeoExt.data.WMSCapabilitiesReader`.
+ *      The proxy is configured to allow caching and issues requests via GET.
+ *      If you require some other proxy/reader combination then you'll have to
+ *      configure this with your own proxy or create a basic
+ *      :class:`GeoExt.data.LayerStore` and configure as needed.
  */
 
-/**
- * Constructor: GeoExt.data.WMSCapabilitiesStore
- * Create a new WMS capabilities store object.
- *
- * Parameters:
- * config - {Object} Store configuration.
- *
- * Configuration options:
- * format - {OpenLayers.Format} A parser for transforming the XHR response into
- *     an array of objects representing attributes.  Defaults to an
- *     {OpenLayers.Format.WMSCapabilities} parser.
- * fields - {Array | Function} Either an Array of field definition objects as
- *     passed to Ext.data.Record.create, or a Record constructor created using
- *     Ext.data.Record.create.  Defaults to ["name", "type"]. 
+/** api: config[format]
+ *  ``OpenLayers.Format``
+ *  A parser for transforming the XHR response into an array of objects
+ *  representing attributes.  Defaults to an ``OpenLayers.Format.WMSCapabilities``
+ *  parser.
  */
+
+/** api: config[fields]
+ *  ``Array | Function``
+ *  Either an Array of field definition objects as passed to
+ *  ``Ext.data.Record.create``, or a record constructor created using
+ *  ``Ext.data.Record.create``.  Defaults to ``["name", "type"]``. 
+ */
+
 GeoExt.data.WMSCapabilitiesStore = function(c) {
     GeoExt.data.WMSCapabilitiesStore.superclass.constructor.call(
         this,