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

[svn_mapbender at osgeo.org]

Author: christoph
Date: 2010-02-24 11:06:35 -0500 (Wed, 24 Feb 2010)
New Revision: 5635

Modified:
   trunk/mapbender/lib/marker.js
Log:


Modified: trunk/mapbender/lib/marker.js
===================================================================
--- trunk/mapbender/lib/marker.js	2010-02-24 15:54:36 UTC (rev 5634)
+++ trunk/mapbender/lib/marker.js	2010-02-24 16:06:35 UTC (rev 5635)
@@ -1,3 +1,35 @@
+/**
+ * Package: Mapbender.Marker
+ * 
+ * Description:
+ * A very basic marker class. Put a (custom) marker at a given location
+ * 
+ * Files:
+ *  - lib/marker.js
+ *
+ * License:
+ * Copyright (c) 2009, Open Source Geospatial Foundation
+ * This program is dual licensed under the GNU General Public License 
+ * and Simplified BSD license.  
+ * http://svn.osgeo.org/mapbender/trunk/mapbender/license/license.txt
+ */
+
+
+/**
+ * Constructor: Mapbender.Marker
+ * 
+ * Parameters:
+ * p - a <Mapbender.Point> to specify the location
+ * map - a <Mapbender.Map> on which the point is rendered
+ * options.img.url - *[optional]* a link to a custom marker image
+ * options.img.offset - *[optional]* a <Mapbender.Point> specifying the offset,
+ * 		default is (0,0). Usually these values are below zero because the image
+ *      has to be translated to top and left
+ * options.img.width - *[optional]* use this to resize the marker image width 
+ *      (height must also be specified)
+ * options.img.height - *[optional]* use this to resize the marker image height
+ *      (width must also be specified)
+ */
 Mapbender.Marker = function (p, map) {
 	var options = {};
 	if (arguments.length > 2 && typeof arguments[2] === "object") {
@@ -48,6 +80,12 @@
 		h.paint();
 	});
 
+	/**
+	 * Method: remove
+	 * 
+	 * Description:
+	 * Remove the marker from the map.
+	 */
 	this.remove = function () {
 		h.clean();
 	};