[Commits] r1435 - core/trunk/geoext/examples

[commits at geoext.org]

Author: tschaub
Date: 2009-10-15 10:00:34 +0200 (Thu, 15 Oct 2009)
New Revision: 1435

Modified:
   core/trunk/geoext/examples/attributes.js
   core/trunk/geoext/examples/feature-grid.js
   core/trunk/geoext/examples/layercontainer.js
   core/trunk/geoext/examples/layeropacityslider.js
   core/trunk/geoext/examples/legendpanel.js
   core/trunk/geoext/examples/mappanel-div.js
   core/trunk/geoext/examples/mappanel-viewport.js
   core/trunk/geoext/examples/mappanel-window.js
   core/trunk/geoext/examples/popup.js
   core/trunk/geoext/examples/search-form.js
   core/trunk/geoext/examples/toolbar.js
   core/trunk/geoext/examples/tree.js
   core/trunk/geoext/examples/wms-capabilities.js
   core/trunk/geoext/examples/zoom-chooser.js
   core/trunk/geoext/examples/zoomslider.js
Log:
Adding doc blocks describing examples.

Modified: core/trunk/geoext/examples/attributes.js
===================================================================
--- core/trunk/geoext/examples/attributes.js	2009-10-15 06:55:30 UTC (rev 1434)
+++ core/trunk/geoext/examples/attributes.js	2009-10-15 08:00:34 UTC (rev 1435)
@@ -6,6 +6,12 @@
  * of the license.
  */
 
+/** api: example[attributes]
+ *  Attribute Store & Reader
+ *  ------------------------
+ *  Create records with attribute types and values with an AttributeStore.
+ */
+
 var store;
 Ext.onReady(function() {
     

Modified: core/trunk/geoext/examples/feature-grid.js
===================================================================
--- core/trunk/geoext/examples/feature-grid.js	2009-10-15 06:55:30 UTC (rev 1434)
+++ core/trunk/geoext/examples/feature-grid.js	2009-10-15 08:00:34 UTC (rev 1435)
@@ -6,6 +6,12 @@
  * of the license.
  */
 
+/** api: example[feature-grid]
+ *  Grid with Features
+ *  ------------------
+ *  Synchronize selection of features between a grid and a layer.
+ */
+
 var mapPanel, store, gridPanel, mainPanel;
 
 Ext.onReady(function() {

Modified: core/trunk/geoext/examples/layercontainer.js
===================================================================
--- core/trunk/geoext/examples/layercontainer.js	2009-10-15 06:55:30 UTC (rev 1434)
+++ core/trunk/geoext/examples/layercontainer.js	2009-10-15 08:00:34 UTC (rev 1435)
@@ -6,6 +6,12 @@
  * of the license.
  */
 
+/** api: example[layercontainer]
+ *  Layer Tree
+ *  ----------
+ *  Create a layer tree with a LayerContainer.
+ */
+
 var store, tree, panel;
 Ext.onReady(function() {
     

Modified: core/trunk/geoext/examples/layeropacityslider.js
===================================================================
--- core/trunk/geoext/examples/layeropacityslider.js	2009-10-15 06:55:30 UTC (rev 1434)
+++ core/trunk/geoext/examples/layeropacityslider.js	2009-10-15 08:00:34 UTC (rev 1435)
@@ -6,6 +6,12 @@
  * of the license.
  */
 
+/** api: example[layeropacityslider]
+ *  Layer Opacity Slider
+ *  --------------------
+ *  Use a slider to control layer opacity.
+ */
+
 var panel1, panel2, wms, slider;
 
 Ext.onReady(function() {

Modified: core/trunk/geoext/examples/legendpanel.js
===================================================================
--- core/trunk/geoext/examples/legendpanel.js	2009-10-15 06:55:30 UTC (rev 1434)
+++ core/trunk/geoext/examples/legendpanel.js	2009-10-15 08:00:34 UTC (rev 1435)
@@ -6,6 +6,13 @@
  * of the license.
  */
 
+/** api: example[legendpanel]
+ *  Legend Panel
+ *  ------------
+ *  Display a layer legend in a panel.
+ */
+
+
 var mapPanel;
 
 Ext.onReady(function() {

Modified: core/trunk/geoext/examples/mappanel-div.js
===================================================================
--- core/trunk/geoext/examples/mappanel-div.js	2009-10-15 06:55:30 UTC (rev 1434)
+++ core/trunk/geoext/examples/mappanel-div.js	2009-10-15 08:00:34 UTC (rev 1435)
@@ -6,6 +6,12 @@
  * of the license.
  */
 
+/** api: example[mappanel-div]
+ *  Map Panel
+ *  ---------
+ *  Render a map panel in any block level page element.
+ */
+
 var mapPanel;
 
 Ext.onReady(function() {

Modified: core/trunk/geoext/examples/mappanel-viewport.js
===================================================================
--- core/trunk/geoext/examples/mappanel-viewport.js	2009-10-15 06:55:30 UTC (rev 1434)
+++ core/trunk/geoext/examples/mappanel-viewport.js	2009-10-15 08:00:34 UTC (rev 1435)
@@ -6,6 +6,12 @@
  * of the license.
  */
 
+/** api: example[mappanel-viewport]
+ *  Map Panel (in a Viewport)
+ *  -------------------------
+ *  Render a map panel in a viewport.
+ */
+
 var mapPanel;
 
 Ext.onReady(function() {

Modified: core/trunk/geoext/examples/mappanel-window.js
===================================================================
--- core/trunk/geoext/examples/mappanel-window.js	2009-10-15 06:55:30 UTC (rev 1434)
+++ core/trunk/geoext/examples/mappanel-window.js	2009-10-15 08:00:34 UTC (rev 1435)
@@ -6,6 +6,12 @@
  * of the license.
  */
 
+/** api: example[mappanel-window]
+ *  Map Panel (in a Window)
+ *  -------------------------
+ *  Render a map panel in a Window.
+ */
+
 var mapPanel;
 
 Ext.onReady(function() {

Modified: core/trunk/geoext/examples/popup.js
===================================================================
--- core/trunk/geoext/examples/popup.js	2009-10-15 06:55:30 UTC (rev 1434)
+++ core/trunk/geoext/examples/popup.js	2009-10-15 08:00:34 UTC (rev 1435)
@@ -6,9 +6,12 @@
  * of the license.
  */
 
-// make the references to the map panel and the popup 
-// global, this is useful for looking at their states
-// from the console
+/** api: example[popup]
+ *  Feature Popup
+ *  -------------
+ *  Display a popup with feature information.
+ */
+
 var mapPanel, popup;
 
 Ext.onReady(function() {

Modified: core/trunk/geoext/examples/search-form.js
===================================================================
--- core/trunk/geoext/examples/search-form.js	2009-10-15 06:55:30 UTC (rev 1434)
+++ core/trunk/geoext/examples/search-form.js	2009-10-15 08:00:34 UTC (rev 1435)
@@ -6,6 +6,12 @@
  * of the license.
  */
 
+/** api: example[search-form]
+ *  Filter Form Panel
+ *  -----------------
+ *  Use a form to build an OpenLayers filter.
+ */
+
 var formPanel;
 
 Ext.onReady(function() {

Modified: core/trunk/geoext/examples/toolbar.js
===================================================================
--- core/trunk/geoext/examples/toolbar.js	2009-10-15 06:55:30 UTC (rev 1434)
+++ core/trunk/geoext/examples/toolbar.js	2009-10-15 08:00:34 UTC (rev 1435)
@@ -6,6 +6,12 @@
  * of the license.
  */
 
+/** api: example[toolbar]
+ *  Toolbar with Actions
+ *  --------------------
+ *  Create a toolbar with GeoExt Actions.
+ */
+
 Ext.onReady(function() {
     Ext.QuickTips.init();
 

Modified: core/trunk/geoext/examples/tree.js
===================================================================
--- core/trunk/geoext/examples/tree.js	2009-10-15 06:55:30 UTC (rev 1434)
+++ core/trunk/geoext/examples/tree.js	2009-10-15 08:00:34 UTC (rev 1435)
@@ -6,6 +6,12 @@
  * of the license.
  */
 
+/** api: example[tree]
+ *  Tree Nodes
+ *  ----------
+ *  Create all kinds of tree nodes.
+ */
+
 var mapPanel;
 Ext.onReady(function() {
     // create a map panel with some layers that we will show in our layer tree

Modified: core/trunk/geoext/examples/wms-capabilities.js
===================================================================
--- core/trunk/geoext/examples/wms-capabilities.js	2009-10-15 06:55:30 UTC (rev 1434)
+++ core/trunk/geoext/examples/wms-capabilities.js	2009-10-15 08:00:34 UTC (rev 1435)
@@ -6,6 +6,13 @@
  * of the license.
  */
 
+
+/** api: example[wms-capabilities]
+ *  WMS Capabilities Store
+ *  ----------------------
+ *  Create layer records from WMS capabilities documents.
+ */
+
 var store;
 Ext.onReady(function() {
     

Modified: core/trunk/geoext/examples/zoom-chooser.js
===================================================================
--- core/trunk/geoext/examples/zoom-chooser.js	2009-10-15 06:55:30 UTC (rev 1434)
+++ core/trunk/geoext/examples/zoom-chooser.js	2009-10-15 08:00:34 UTC (rev 1435)
@@ -6,6 +6,12 @@
  * of the license.
  */
 
+/** api: example[zoom-chooser]
+ *  Scale Chooser
+ *  -------------
+ *  Use a ComboBox to display available map scales.
+ */
+
 var mapPanel;
 
 Ext.onReady(function() {

Modified: core/trunk/geoext/examples/zoomslider.js
===================================================================
--- core/trunk/geoext/examples/zoomslider.js	2009-10-15 06:55:30 UTC (rev 1434)
+++ core/trunk/geoext/examples/zoomslider.js	2009-10-15 08:00:34 UTC (rev 1435)
@@ -6,6 +6,12 @@
  * of the license.
  */
 
+/** api: example[zoomslider]
+ *  Zoom Slider
+ *  -----------
+ *  Use a slider to control map scale.
+ */
+
 var panel, slider;
 
 Ext.onReady(function() {