[Commits] r905 - core/trunk/geoext/lib/GeoExt/widgets/tree
commits at geoext.org
commits at geoext.org
Fri May 29 20:53:52 CEST 2009
Author: ahocevar
Date: 2009-05-29 20:53:51 +0200 (Fri, 29 May 2009)
New Revision: 905
Modified:
core/trunk/geoext/lib/GeoExt/widgets/tree/BaseLayerContainer.js
core/trunk/geoext/lib/GeoExt/widgets/tree/LayerContainer.js
core/trunk/geoext/lib/GeoExt/widgets/tree/LayerNode.js
core/trunk/geoext/lib/GeoExt/widgets/tree/OverlayLayerContainer.js
Log:
updated copyright, replaced ND comments with rst doc comments for widgets/tree/* (see #53)
Modified: core/trunk/geoext/lib/GeoExt/widgets/tree/BaseLayerContainer.js
===================================================================
--- core/trunk/geoext/lib/GeoExt/widgets/tree/BaseLayerContainer.js 2009-05-29 14:58:58 UTC (rev 904)
+++ core/trunk/geoext/lib/GeoExt/widgets/tree/BaseLayerContainer.js 2009-05-29 18:53:51 UTC (rev 905)
@@ -1,43 +1,49 @@
-/**
- * Copyright (c) 2008 The Open Planning Project
- */
+/* Copyright (C) 2008-2009 The Open Source Geospatial Foundation ¹
+ * Published under the BSD license.
+ * See http://geoext.org/svn/geoext/core/trunk/license.txt for the full text
+ * of the license.
+ *
+ * ¹ pending approval */
/**
* @requires GeoExt/widgets/tree/LayerContainer.js
*/
Ext.namespace("GeoExt.tree");
-/**
- * Class: GeoExt.tree.BaseLayerContainer
+/** api: (define)
+ * module = GeoExt.tree
+ * class = BaseLayerContainer
+ */
+
+/** api: (extends)
+ * GeoExt/widgets/tree/LayerContainer.js
+ */
+
+/** api: constructor
+ * .. class:: BaseLayerContainer
*
- * A layer container that will collect all base layers of an OpenLayers map.
- * Only layers that have displayInLayerSwitcher set to true will be included.
+ * A layer container that will collect all base layers of an OpenLayers
+ * map. Only layers that have displayInLayerSwitcher set to true will be
+ * included.
*
- * To use this node type in JSON config, set nodeType to
- * "olBaseLayerContainer".
- *
- * Inherits from:
- * - <GeoExt.tree.LayerContainer>
+ * To use this node type in ``TreePanel`` config, set nodeType to
+ * "gx_baselayercontainer".
*/
GeoExt.tree.BaseLayerContainer = Ext.extend(GeoExt.tree.LayerContainer, {
- /**
- * Constructor: GeoExt.tree.BaseLayerContainer
- *
- * Parameters:
- * config - {Object}
+ /** private: method[constructor]
+ * Private constructor override.
*/
constructor: function(config) {
config.text = config.text || "Base Layer";
GeoExt.tree.BaseLayerContainer.superclass.constructor.apply(this, arguments);
},
- /**
- * Method: addLayerNode
- * Adds a child node representing a base layer of the map
+ /** private: method[addLayerNode]
+ * :param layerRecord: ``Ext.data.Record`` the layer record to add a node
+ * for
*
- * Parameters:
- * layerRecord - {Ext.data.Record} the layer record to add a node for
+ * Adds a child node representing a base layer of the map.
*/
addLayerNode: function(layerRecord) {
var layer = layerRecord.get("layer");
@@ -47,12 +53,11 @@
}
},
- /**
- * Method: removeLayerNode
- * Removes a child node representing a base layer of the map
- *
- * Parameters:
- * layerRecord - {Ext.data.Record} the layer record to remove the node for
+ /** private: method[removeLayerNode]
+ * :param layerRecord: ``Ext.data.Record`` the layer record to remove the
+ * node for
+ *
+ * Removes a child node representing a base layer of the map.
*/
removeLayerNode: function(layerRecord) {
var layer = layerRecord.get("layer");
Modified: core/trunk/geoext/lib/GeoExt/widgets/tree/LayerContainer.js
===================================================================
--- core/trunk/geoext/lib/GeoExt/widgets/tree/LayerContainer.js 2009-05-29 14:58:58 UTC (rev 904)
+++ core/trunk/geoext/lib/GeoExt/widgets/tree/LayerContainer.js 2009-05-29 18:53:51 UTC (rev 905)
@@ -1,6 +1,9 @@
-/**
- * Copyright (c) 2008 The Open Planning Project
- */
+/* Copyright (C) 2008-2009 The Open Source Geospatial Foundation ¹
+ * Published under the BSD license.
+ * See http://geoext.org/svn/geoext/core/trunk/license.txt for the full text
+ * of the license.
+ *
+ * ¹ pending approval */
/**
* @include GeoExt/widgets/tree/LayerNode.js
@@ -22,7 +25,7 @@
* for base layers, and to "layer-icon" for overlay layers.
*
* To use this node type in ``TreePanel`` config, set nodeType to
- * "olLayerContainer".
+ * "gx_layercontainer".
*/
GeoExt.tree.LayerContainer = Ext.extend(Ext.tree.TreeNode, {
Modified: core/trunk/geoext/lib/GeoExt/widgets/tree/LayerNode.js
===================================================================
--- core/trunk/geoext/lib/GeoExt/widgets/tree/LayerNode.js 2009-05-29 14:58:58 UTC (rev 904)
+++ core/trunk/geoext/lib/GeoExt/widgets/tree/LayerNode.js 2009-05-29 18:53:51 UTC (rev 905)
@@ -1,6 +1,10 @@
-/**
- * Copyright (c) 2008 The Open Planning Project
- */
+/* Copyright (C) 2008-2009 The Open Source Geospatial Foundation ¹
+ * Published under the BSD license.
+ * See http://geoext.org/svn/geoext/core/trunk/license.txt for the full text
+ * of the license.
+ *
+ * ¹ pending approval */
+
Ext.namespace("GeoExt.tree");
/** private: constructor
Modified: core/trunk/geoext/lib/GeoExt/widgets/tree/OverlayLayerContainer.js
===================================================================
--- core/trunk/geoext/lib/GeoExt/widgets/tree/OverlayLayerContainer.js 2009-05-29 14:58:58 UTC (rev 904)
+++ core/trunk/geoext/lib/GeoExt/widgets/tree/OverlayLayerContainer.js 2009-05-29 18:53:51 UTC (rev 905)
@@ -1,31 +1,38 @@
-/**
- * Copyright (c) 2008 The Open Planning Project
- */
+/* Copyright (C) 2008-2009 The Open Source Geospatial Foundation ¹
+ * Published under the BSD license.
+ * See http://geoext.org/svn/geoext/core/trunk/license.txt for the full text
+ * of the license.
+ *
+ * ¹ pending approval */
/**
* @requires GeoExt/widgets/tree/LayerContainer.js
*/
Ext.namespace("GeoExt.tree");
-/**
- * Class: GeoExt.tree.OverlayLayerContainer
+/** api: (define)
+ * module = GeoExt.tree
+ * class = OverlayLayerContainer
+ */
+
+/** api: (extends)
+ * GeoExt/widgets/tree/LayerContainer.js
+ */
+
+/** api: constructor
+ * .. class:: OverlayLayerContainer
*
- * A layer container that will collect all overlay layers of an OpenLayers map.
- * Only layers that have displayInLayerSwitcher set to true will be included.
+ * A layer container that will collect all overlay layers of an OpenLayers
+ * map. Only layers that have displayInLayerSwitcher set to true will be
+ * included.
*
- * To use this node type in JSON config, set nodeType to
- * "olOverlayLayerContainer".
- *
- * Inherits from:
- * - <GeoExt.tree.LayerContainer>
+ * To use this node type in ``TreePanel`` config, set nodeType to
+ * "gx_overlaylayerontainer".
*/
GeoExt.tree.OverlayLayerContainer = Ext.extend(GeoExt.tree.LayerContainer, {
- /**
- * Constructor: GeoExt.tree.OverlayLayerContainer
- *
- * Parameters:
- * config - {Object}
+ /** private: method[constructor]
+ * Private constructor override.
*/
constructor: function(config) {
config.text = config.text || "Overlays";
@@ -33,12 +40,11 @@
arguments);
},
- /**
- * Method: addLayerNode
- * Adds a child node representing a overlay layer of the map
- *
- * Parameters:
- * layerRecord - {Ext.data.Record} the layer record to add a node for
+ /** private: method[addLayerNode]
+ * :param layerRecord: ``Ext.data.Record`` the layer record to add a node
+ * for
+ *
+ * Adds a child node representing a overlay layer of the map.
*/
addLayerNode: function(layerRecord) {
var layer = layerRecord.get("layer");
@@ -48,12 +54,11 @@
}
},
- /**
- * Method: removeLayerNode
- * Removes a child node representing an overlay layer of the map
- *
- * Parameters:
- * layerRecord - {Ext.data.Record} the layer record to remove the node for
+ /** private: method[removeLayerNode]
+ * :param layerRecord: ``Ext.data.Record`` the layer record to remove the
+ * node for
+ *
+ * Removes a child node representing an overlay layer of the map.
*/
removeLayerNode: function(layerRecord) {
var layer = layerRecord.get("layer");
More information about the Commits
mailing list