[Mapbender-commits] r5063 - trunk/mapbender/lib

[svn_mapbender at osgeo.org]

Author: kmq
Date: 2009-12-03 04:12:54 -0500 (Thu, 03 Dec 2009)
New Revision: 5063

Modified:
   trunk/mapbender/lib/resultGeometryListController.js
Log:
Clean up a little an add documantation

Modified: trunk/mapbender/lib/resultGeometryListController.js
===================================================================
--- trunk/mapbender/lib/resultGeometryListController.js	2009-12-03 08:54:19 UTC (rev 5062)
+++ trunk/mapbender/lib/resultGeometryListController.js	2009-12-03 09:12:54 UTC (rev 5063)
@@ -15,7 +15,12 @@
 	var columns = [];
 
 
-	// adding
+	/*
+	 * Method: addFeature
+	 * Description: adds a Feature to the Model
+	 * Parameters:
+	 * feature - a geoJSON featuree
+	*/
 	this.addFeature = function(feature) {
 		if (this.wfsConfId === null){
 			// or throw an exception?
@@ -24,12 +29,22 @@
 		var result = this.model.addFeature(feature);
 	};
 
-	// featureCollection is geoJSON
-	this.addFeatureCollection = function(featureCollection){
-		var result = this.model.addFeatureCollection(featureCollection);
+	/*
+	 * Method: addFeatureCollection
+	 * Description: adds a FeatureCollection to the Model
+	 * Parameters:
+	 * geoJSON - a geoJSON featureCollection
+	*/
+	this.addFeatureCollection = function(geoJSON){
+		var result = this.model.addFeatureCollection(geoJSON);
 	};
 
-	//called if a FeatureCollection was successfully added to the model
+	/*
+	 * Method: addFeatureCollection_callback
+	 * Description: The callback received from the Model upon successfully adding a Feature
+	 * Parameters:
+	 * featureEntryCollection - an array of (index,featureCollection) tuples
+	*/
 	var addFeatureCollection_callback = function(featureEntryCollection){
 	// featureEntryCollection is an array of {index: <index>, feature: <feature>}
 	// where <index> is the index in the model, and feature a featuireCollection