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

[commits at geoext.org]

Author: tschaub
Date: 2009-05-29 22:12:58 +0200 (Fri, 29 May 2009)
New Revision: 914

Modified:
   core/trunk/geoext/lib/GeoExt/data/FeatureRecord.js
Log:
Documenting the create class method.

Modified: core/trunk/geoext/lib/GeoExt/data/FeatureRecord.js
===================================================================
--- core/trunk/geoext/lib/GeoExt/data/FeatureRecord.js	2009-05-29 20:12:28 UTC (rev 913)
+++ core/trunk/geoext/lib/GeoExt/data/FeatureRecord.js	2009-05-29 20:12:58 UTC (rev 914)
@@ -27,18 +27,14 @@
     {name: "feature"}, {name: "state"}, {name: "fid"}
 ]);
 
-/**
- * APIFunction: GeoExt.data.FeatureRecord.create
- * Creates a constructor for a FeatureRecord, optionally with additional
- * fields.
- * 
- * Parameters:
- * o - {Array} Field definition as in {Ext.data.Record.create}. Can be omitted
- *     if no additional fields are required (records will always have fields
- *     {OpenLayers.Feature} "feature", {String} "state" and {String} "fid".
- *
- * Returns:
- * {Function} A specialized {<GeoExt.data.FeatureRecord>} constructor.
+/** api: classmethod[create]
+ *  :param o: ``Array`` Field definition as in ``Ext.data.Record.create``. Can
+ *      be omitted if no additional fields are required.
+ *  :return: ``Function`` A specialized :class:GeoExt.data.LayerRecord`
+ *      constructor.
+ *  
+ * Creates a constructor for a :class:`GeoExt.data.FeatureRecord`, optionally
+ * with additional fields.
  */
 GeoExt.data.FeatureRecord.create = function(o) {
     var f = Ext.extend(GeoExt.data.FeatureRecord, {});