[Commits] r588 - in core/trunk/geoext/lib/GeoExt: data widgets
commits at geoext.org
commits at geoext.org
Sat May 2 00:48:51 CEST 2009
Author: tschaub
Date: 2009-05-02 00:48:51 +0200 (Sat, 02 May 2009)
New Revision: 588
Modified:
core/trunk/geoext/lib/GeoExt/data/FeatureReader.js
core/trunk/geoext/lib/GeoExt/data/FeatureRecord.js
core/trunk/geoext/lib/GeoExt/data/FeatureStore.js
core/trunk/geoext/lib/GeoExt/widgets/MapPanel.js
Log:
New marker for api doc comments is api instead of jst.
Modified: core/trunk/geoext/lib/GeoExt/data/FeatureReader.js
===================================================================
--- core/trunk/geoext/lib/GeoExt/data/FeatureReader.js 2009-05-01 22:47:33 UTC (rev 587)
+++ core/trunk/geoext/lib/GeoExt/data/FeatureReader.js 2009-05-01 22:48:51 UTC (rev 588)
@@ -21,14 +21,14 @@
* @include GeoExt/data/FeatureRecord.js
*/
-/** jst: (define)
+/** api: (define)
* module = GeoExt.data
* class = FeatureReader
* base_link = `Ext.data.DataReader <http://extjs.com/deploy/dev/docs/?class=Ext.data.DataReader>`_
*/
Ext.namespace('GeoExt', 'GeoExt.data');
-/** jst: example
+/** api: example
* Typical usage in a store:
*
* .. code-block:: javascript
@@ -42,7 +42,7 @@
*
*/
-/** jst: constructor
+/** api: constructor
* .. class:: FeatureReader(meta, recordType)
*
* Data reader class to create an array of
@@ -81,7 +81,7 @@
return this.readRecords(response.features);
},
- /** jst: method[readReacords]
+ /** api: method[readReacords]
* :param features: ``Array(OpenLayers.Feature.Vector)`` List of
* features for creating records
* :return: ``Object`` An object with ``records`` and ``totalRecords``
Modified: core/trunk/geoext/lib/GeoExt/data/FeatureRecord.js
===================================================================
--- core/trunk/geoext/lib/GeoExt/data/FeatureRecord.js 2009-05-01 22:47:33 UTC (rev 587)
+++ core/trunk/geoext/lib/GeoExt/data/FeatureRecord.js 2009-05-01 22:48:51 UTC (rev 588)
@@ -5,14 +5,14 @@
*
* pending approval */
-/** jst: (define)
+/** api: (define)
* module = GeoExt.data
* class = FeatureRecord
* base_link = `Ext.data.Record <http://extjs.com/deploy/dev/docs/?class=Ext.data.Record>`_
*/
Ext.namespace("GeoExt.data");
-/** jst: constructor
+/** api: constructor
* .. class:: FeatureRecord
*
* A record that represents an ``OpenLayers.Feature.Vector``. This record
Modified: core/trunk/geoext/lib/GeoExt/data/FeatureStore.js
===================================================================
--- core/trunk/geoext/lib/GeoExt/data/FeatureStore.js 2009-05-01 22:47:33 UTC (rev 587)
+++ core/trunk/geoext/lib/GeoExt/data/FeatureStore.js 2009-05-01 22:48:51 UTC (rev 588)
@@ -9,21 +9,21 @@
* @include GeoExt/data/FeatureReader.js
*/
-/** jst: (define)
+/** api: (define)
* module = GeoExt.data
* class = FeatureStore
* base_link = `Ext.data.DataStore <http://extjs.com/deploy/dev/docs/?class=Ext.data.DataStore>`_
*/
Ext.namespace("GeoExt.data");
-/** jst: constructor
+/** api: constructor
* .. class:: FeatureStore
*
* A store containing :class:`GeoExt.data.FeatureRecord` entries that
* optionally synchronizes with an ``OpenLayers.Layer.Vector``.
*/
-/** jst: example
+/** api: example
* Sample code to create a store with features from a vector layer:
*
* .. code-block:: javascript
@@ -60,37 +60,37 @@
*/
GeoExt.data.FeatureStoreMixin = {
- /** jst: config[layer]
+ /** api: config[layer]
* ``OpenLayers.Layer.Vector`` Layer to synchronize the store with.
*/
layer: null,
- /** jst: config[features]
+ /** api: config[features]
* ``Array(OpenLayers.Feature.Vector)`` Features that will be added to the
* store (and the layer if provided).
*/
- /** jst: config[reader]
+ /** api: config[reader]
* ``Ext.data.DataReader`` The reader used to produce records from objects
* features. Default is :class:`GeoExt.data.FeatureReader`.
*/
reader: null,
- /** jst: config[addFeatureFilter]
+ /** api: config[addFeatureFilter]
* ``Function`` This function is called before a feature record is added to
* the store, it receives the feature from which a feature record is to be
* created, if it returns false then no record is added.
*/
addFeatureFilter: null,
- /** jst: config[addRecordFilter]
+ /** api: config[addRecordFilter]
* ``Function`` This function is called before a feature is added to the
* layer, it receives the feature record associated with the feature to be
* added, if it returns false then no feature is added.
*/
addRecordFilter: null,
- /** jst: config[initDir]
+ /** api: config[initDir]
* ``Number`` Bitfields specifying the direction to use for the
* initial sync between the layer and the store, if set to 0 then no
* initial sync is done. Default is
@@ -118,7 +118,7 @@
}
},
- /** jst: method[bind]
+ /** api: method[bind]
* :param layer: ``OpenLayers.Layer`` Layer that the store should be
* synchronized with.
*
@@ -169,7 +169,7 @@
});
},
- /** jst: method[unbind]
+ /** api: method[unbind]
* Unbind this store from the layer it is currently bound.
*/
unbind: function() {
Modified: core/trunk/geoext/lib/GeoExt/widgets/MapPanel.js
===================================================================
--- core/trunk/geoext/lib/GeoExt/widgets/MapPanel.js 2009-05-01 22:47:33 UTC (rev 587)
+++ core/trunk/geoext/lib/GeoExt/widgets/MapPanel.js 2009-05-01 22:48:51 UTC (rev 588)
@@ -9,14 +9,14 @@
* @include GeoExt/data/LayerStore.js
*/
-/** jst: (define)
+/** api: (define)
* module = GeoExt
* class = MapPanel
* base_link = `Ext.Panel <http://extjs.com/deploy/dev/docs/?class=Ext.Panel>`_
*/
Ext.namespace("GeoExt");
-/** jst: example
+/** api: example
* Sample code to create a panel with a new map:
*
* .. code-block:: javascript
@@ -42,49 +42,49 @@
* });
*/
-/** jst: constructor
+/** api: constructor
* .. class:: MapPanel(config)
*
* Create a panel container for a map.
*/
GeoExt.MapPanel = Ext.extend(Ext.Panel, {
- /** jst: config[map]
+ /** api: config[map]
* ``OpenLayers.Map or Object`` A configured map or a configuration object
* for the map constructor. A configured map will be available after
* construction through the :attr:`map` property.
*/
- /** jst: property[map]
+ /** api: property[map]
* ``OpenLayers.Map`` A configured map object.
*/
map: null,
- /** jst: config[layers]
+ /** api: config[layers]
* ``GeoExt.data.LayerStore or GeoExt.data.GroupingStore or Array(OpenLayers.Layer)``
* A store holding records. If not provided, an empty
* :class:`GeoExt.data.LayerStore` will be created.
*/
- /** jst: property[layers]
+ /** api: property[layers]
* :class:`GeoExt.data.LayerStore` A store containing
* :class:`GeoExt.data.LayerRecord` objects.
*/
layers: null,
- /** jst: config[center]
+ /** api: config[center]
* ``OpenLayers.LonLat or Array(Number)`` A location for the map center. If
* an array is provided, the first two items should represent x & y coordinates.
*/
center: null,
- /** jst: config[zoom]
+ /** api: config[zoom]
* ``Number`` An initial zoom level for the map.
*/
zoom: null,
- /** jst: config[extent]
+ /** api: config[extent]
* ``OpenLayers.Bounds or Array(Number)`` An initial extent for the map (used
* if center and zoom are not provided. If an array, the first four items
* should be minx, miny, maxx, maxy.
@@ -182,5 +182,5 @@
});
-/** jst: xtype = gx_mappanel */
+/** api: xtype = gx_mappanel */
Ext.reg('gx_mappanel', GeoExt.MapPanel);
More information about the Commits
mailing list