[Commits] r893 - core/trunk/geoext/lib/GeoExt/widgets/tree

[commits at geoext.org]

Author: tschaub
Date: 2009-05-29 00:03:41 +0200 (Fri, 29 May 2009)
New Revision: 893

Modified:
   core/trunk/geoext/lib/GeoExt/widgets/tree/LayerNode.js
Log:
Remaining docs for LayerNode.

Modified: core/trunk/geoext/lib/GeoExt/widgets/tree/LayerNode.js
===================================================================
--- core/trunk/geoext/lib/GeoExt/widgets/tree/LayerNode.js	2009-05-28 21:30:25 UTC (rev 892)
+++ core/trunk/geoext/lib/GeoExt/widgets/tree/LayerNode.js	2009-05-28 22:03:41 UTC (rev 893)
@@ -109,7 +109,8 @@
  *      checked attribute, but radioGroup is a string that identifies the options
  *      group. Clicking the radio button will fire a radioChange event.
  * 
- *      To use this node type in a JSON config, set nodeType to "gx_layer".
+ *      To use this node type in a ``TreePanel`` config, set ``nodeType`` to
+ *      "gx_layer".
  */
 GeoExt.tree.LayerNode = Ext.extend(Ext.tree.TreeNode, {
     
@@ -152,11 +153,8 @@
      */
     visibilityChanging: false,
     
-    /**
-     * Constructor: GeoExt.tree.LayerNode
-     * 
-     * Parameters:
-     * config - {Object}
+    /** private: method[constructor]
+     *  Private constructor override.
      */
     constructor: function(config) {
         config.leaf = config.leaf || !config.children;
@@ -169,10 +167,9 @@
         
         this.defaultUI = this.defaultUI || GeoExt.tree.LayerNodeUI;
         this.addEvents(
-            /**
-             * Event: radiochange
-             * Notifies listener when a differnt radio button was selected.
-             * Will be called with the currently selected node as argument.
+            /** api: event[radiochange]
+             *  Notifies listener when a differnt radio button was selected.
+             *  Will be called with the currently selected node as argument.
              */
             "radiochange"
         );
@@ -185,12 +182,8 @@
         GeoExt.tree.LayerNode.superclass.constructor.apply(this, arguments);
     },
 
-    /**
-     * Method: render
-     * 
-     * Properties:
-     * bulkRender {Boolean} - optional
-     * layer {<OpenLayers.Layer>} - optional
+    /** private: method[render]
+     *  :param bulkRender: ``Boolean``
      */
     render: function(bulkRender) {
         var layer = this.layer instanceof OpenLayers.Layer && this.layer;
@@ -238,10 +231,9 @@
         GeoExt.tree.LayerNode.superclass.render.call(this, bulkRender);
     },
     
-    /**
-     * Method: addVisibilityHandlers
-     * Adds handlers that sync the checkbox state with the layer's visibility
-     * state
+    /** private: method[addVisibilityHandlers]
+     *  Adds handlers that sync the checkbox state with the layer's visibility
+     *  state
      */
     addVisibilityEventHandlers: function() {
         this.layer.events.register("visibilitychanged", this, function() {
@@ -261,10 +253,9 @@
         });
     },
     
-    /**
-     * Method: addStoreEventHandlers
-     * Adds handlers that make sure the node disappeares when the layer is
-     * removed from the store, and appears when it is re-added.
+    /** private: method[addStoreEventHandlers]
+     *  Adds handlers that make sure the node disappeares when the layer is
+     *  removed from the store, and appears when it is re-added.
      */
     addStoreEventHandlers: function() {
         this.layerStore.on({
@@ -292,10 +283,9 @@
         });
     },
     
-    /**
-     * Method: addChildNodes
-     * Calls the add method of a node type configured as <childNodeType>
-     * to add children.
+    /** private: method[addChildNodes]
+     *  Calls the add method of a node type configured as ``childNodeType``
+     *  to add children.
      */
     addChildNodes: function() {
         if(typeof this.childNodeType == "string") {