[Commits] r1134 - core/trunk/geoext/lib/GeoExt/widgets

[commits at geoext.org]

Author: ahocevar
Date: 2009-06-23 10:00:49 +0200 (Tue, 23 Jun 2009)
New Revision: 1134

Modified:
   core/trunk/geoext/lib/GeoExt/widgets/form.js
Log:
changed doc comments to rst style. Since everything here is private, it does not make a lot of sense, but I thought it is good practice to use the same documentation style everywhere. Non-functional change.

Modified: core/trunk/geoext/lib/GeoExt/widgets/form.js
===================================================================
--- core/trunk/geoext/lib/GeoExt/widgets/form.js	2009-06-23 07:29:47 UTC (rev 1133)
+++ core/trunk/geoext/lib/GeoExt/widgets/form.js	2009-06-23 08:00:49 UTC (rev 1134)
@@ -8,20 +8,16 @@
 
 Ext.namespace("GeoExt.form");
 
-/**
- * Function: GeoExt.form.toFilter
- * Create an {OpenLayers.Filter} object from a {Ext.form.BasicForm}
- *     or a {Ext.form.FormPanel} instance.
- *
- * Parameters:
- * form - {Ext.form.BasicForm|Ext.form.FormPanel}
- * logicalOp - {String} Either {OpenLayers.Filter.Logical.AND}
- *     or {OpenLayers.Filter.Logical.OR}, set to
- *     {OpenLayers.Filter.Logical.AND} if null or
- *     undefined.
- *
- * Returns:
- * {OpenLayers.Filter}
+/** private: function[toFilter]
+ *  :param form: ``Ext.form.BasicForm|Ext.form.FormPanel``
+ *  :param logicalOp: ``String`` Either ``OpenLayers.Filter.Logical.AND`` or
+ *      ``OpenLayers.Filter.Logical.OR``, set to
+ *      ``OpenLayers.Filter.Logical.AND`` if null or undefined
+ *      
+ *  :return: ``OpenLayers.Filter``
+ *  
+ *  Create an {OpenLayers.Filter} object from a {Ext.form.BasicForm}
+ *      or a {Ext.form.FormPanel} instance.
  */
 GeoExt.form.toFilter = function(form, logicalOp) {
     if(form instanceof Ext.form.FormPanel) {
@@ -55,10 +51,9 @@
     });
 };
 
-/**
- * Constant: GeoExt.form.omForm.FILTER_MAP
- * An object mapping operator strings as found in field names to
- *     {OpenLayers.Filter.Comparison} types.
+/** private: constant[FILTER_MAP]
+ *  An object mapping operator strings as found in field names to
+ *      ``OpenLayers.Filter.Comparison`` types.
  */
 GeoExt.form.toFilter.FILTER_MAP = {
     "eq": OpenLayers.Filter.Comparison.EQUAL_TO,