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

[commits at geoext.org]

Author: tschaub
Date: 2009-12-02 01:21:19 +0100 (Wed, 02 Dec 2009)
New Revision: 1534

Modified:
   core/trunk/geoext/lib/GeoExt/widgets/FeatureRenderer.js
Log:
FeatureRenderer doc corrections.

Modified: core/trunk/geoext/lib/GeoExt/widgets/FeatureRenderer.js
===================================================================
--- core/trunk/geoext/lib/GeoExt/widgets/FeatureRenderer.js	2009-12-01 23:28:57 UTC (rev 1533)
+++ core/trunk/geoext/lib/GeoExt/widgets/FeatureRenderer.js	2009-12-02 00:21:19 UTC (rev 1534)
@@ -13,6 +13,11 @@
  */
 Ext.namespace('GeoExt');
 
+/** api: constructor
+ *  .. class:: FeatureRenderer(config)
+ *   
+ *      Create a box component for rendering a vector feature.
+ */
 GeoExt.FeatureRenderer = Ext.extend(Ext.BoxComponent, {
 
     /** api: config[feature]
@@ -32,8 +37,8 @@
 
     /** api: config[symbolType]
      *  ``String``
-     *   One of ``"Point"``, ``"Line"``, or ``"Polygon"``.  If ``feature``
-     *   is provided, it will be preferred.  Default is ``"Point"``.
+     *  One of ``"Point"``, ``"Line"``, or ``"Polygon"``.  If ``feature``
+     *  is provided, it will be preferred.  Default is ``"Point"``.
      */
     symbolType: "Point",
 
@@ -131,7 +136,8 @@
              *  Fires when the feature is clicked on.
              *
              *  Listener arguments:
-             *  * renderer - ``GeoExt.FeatureRenderer`` This feature renderer.
+             *  
+             *  * renderer - :class:`GeoExt.FeatureRenderer` This feature renderer.
              */
             "click"
         );
@@ -248,6 +254,7 @@
      *  Update the symbolizers used to render the feature.
      *
      *  Valid options:
+     *  
      *  * draw - ``Boolean`` Draw the feature after setting it.  Default is ``true``.
      */
     setSymbolizers: function(symbolizers, options) {
@@ -264,6 +271,7 @@
      *  Create a new feature based on the geometry type and render it.
      *
      *  Valid options:
+     *  
      *  * draw - ``Boolean`` Draw the feature after setting it.  Default is ``true``.
      */
     setSymbolType: function(type, options) {
@@ -279,6 +287,7 @@
      *  Update the feature and redraw.
      *
      *  Valid options:
+     *  
      *  * draw - ``Boolean`` Draw the feature after setting it.  Default is ``true``.
      */
     setFeature: function(feature, options) {
@@ -309,6 +318,7 @@
      *  the feature.
      *
      *  Valid options:
+     *  
      *  * feature - ``OpenLayers.Feature.Vector`` The new or updated feature.  
      *      If provided, the feature gets precedence over ``symbolType``.
      *  * symbolType - ``String`` One of the allowed ``symbolType`` values.