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

[commits at geoext.org]

Author: tschaub
Date: 2009-04-30 05:58:20 +0200 (Thu, 30 Apr 2009)
New Revision: 542

Modified:
   core/trunk/geoext/lib/GeoExt/data/FeatureRecord.js
Log:
Docs for FeatureRecord.  Since copy and create are exactly as in Ext, I'm inclined not to document them here.  Will go to list for opinions  (see #53).

Modified: core/trunk/geoext/lib/GeoExt/data/FeatureRecord.js
===================================================================
--- core/trunk/geoext/lib/GeoExt/data/FeatureRecord.js	2009-04-30 03:33:09 UTC (rev 541)
+++ core/trunk/geoext/lib/GeoExt/data/FeatureRecord.js	2009-04-30 03:58:20 UTC (rev 542)
@@ -5,17 +5,23 @@
  * 
  * pending approval */
 
+/** jst: (define)
+ *  module = GeoExt.data
+ *  class = FeatureRecord
+ *  base_link = `Ext.data.Record <http://localhost/projects/gx/trunk/ext/docs/?class=Ext.data.Record>`_
+ */
 Ext.namespace("GeoExt.data");
 
-/**
- * Class: GeoExt.data.FeatureRecord
- * A subclass of {Ext.data.Record} which provides a special record that
- * represents an {OpenLayers.Feature}. This record will always have at
- * least "feature", "fid", and "state" fields in its data. The id of
- * the record will be the same as the id of the feature it represents.
- * 
- * Inherits from
- * - {Ext.data.Record}
+/** jst: constructor
+ *  .. class:: FeatureRecord
+ *  
+ *      A record that represents an ``OpenLayers.Feature.Vector``. This record
+ *      will always have at least the following fields:
+ *
+ *      * feature ``OpenLayers.Feature.Vector``
+ *      * state ``String``
+ *      * fid ``String``
+ *
  */
 GeoExt.data.FeatureRecord = Ext.data.Record.create([
     {name: "feature"}, {name: "state"}, {name: "fid"}