gordonbanderson / Mappable

code/MapAPI.php

Doc Comments +28 added lines, -22 removed lines

@@ -163,7 +163,7 @@ 
 	 *
 	 * @param string  $googleMapKey the googleMapKey
 	 *
-	 * @return void
+	 * @return MapAPI
 	 */
 
 	public function setKey($googleMapKey) {
@@ -171,6 +171,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param boolean $inclusion
+	 */
 	public function setIncludeDownloadJavascript($inclusion) {
 		self::$include_download_javascript = $inclusion;
 		return $this;
@@ -207,7 +210,7 @@ 
 	 * @param int     $gridSize         grid size
 	 * @param int     $maxZoom 			max zoom to cluster at
 	 *
-	 * @return void
+	 * @return MapAPI
 	 */
 
 	public function setClusterer($useClusterer, $gridSize=50, $maxZoom=17,
@@ -224,7 +227,7 @@ 
 	 *
 	 * @param string  $googleMapId the google div ID
 	 *
-	 * @return void
+	 * @return MapAPI
 	 */
 
 	public function setDivId($googleMapId) {
@@ -237,7 +240,7 @@ 
 	 *
 	 * @param string  $googleMapDirectionId GoogleMap  Direction ID for the HTML DIV
 	 *
-	 * @return void
+	 * @return MapAPI
 	 */
 
 	public function setDirectionDivId($googleMapDirectionId) {
@@ -252,7 +255,7 @@ 
 	 * @param int     $width  GoogleMap  width
 	 * @param int     $height GoogleMap  height
 	 *
-	 * @return void
+	 * @return MapAPI
 	 */
 
 	public function setSize($width, $height) {
@@ -268,7 +271,7 @@ 
 	 * @param int     $iconWidth  GoogleMap  marker icon width
 	 * @param int     $iconHeight GoogleMap  marker icon height
 	 *
-	 * @return void
+	 * @return MapAPI
 	 */
 
 	public function setIconSize($iconWidth, $iconHeight) {
@@ -282,7 +285,7 @@ 
 	 *
 	 * @param string  $lang GoogleMap  lang : fr,en,..
 	 *
-	 * @return void
+	 * @return MapAPI
 	 */
 
 	public function setLang($lang) {
@@ -295,7 +298,7 @@ 
 	 *
 	 * @param int $zoom GoogleMap zoom.
 	 *
-	 * @return void
+	 * @return MapAPI
 	 */
 
 	public function setZoom($zoom) {
@@ -308,7 +311,7 @@ 
 	 *
 	 * @param int 	$infoWindowZoom GoogleMap information window zoom.
 	 *
-	 * @return void
+	 * @return MapAPI
 	 */
 
 	public function setInfoWindowZoom($infoWindowZoom) {
@@ -319,9 +322,8 @@ 
 	/**
 	 * Enable the zoom on the marker when you click on it
 	 *
-	 * @param int     $zoom GoogleMap  zoom.
 	 *
-	 * @return void
+	 * @return MapAPI
 	 */
 
 	public function setEnableWindowZoom($enableWindowZoom) {
@@ -332,9 +334,9 @@ 
 	/**
 	 * Enable theautomatic center/zoom at the gmap load
 	 *
-	 * @param int     $zoom GoogleMap  zoom.
 	 *
-	 * @return void
+	 * @param boolean $enableAutomaticCenterZoom
+	 * @return MapAPI
 	 */
 
 	public function setEnableAutomaticCenterZoom($enableAutomaticCenterZoom) {
@@ -347,7 +349,7 @@ 
 	 *
 	 * @param string  $center GoogleMap  center (an address)
 	 *
-	 * @return void
+	 * @return MapAPI
 	 */
 
 	public function setCenter($center) {
@@ -362,7 +364,7 @@ 
 	 *
 	 * @param string  $mapType  Can be one of road,satellite,hybrid or terrain. Defaults to road
 	 *
-	 * @return void
+	 * @return MapAPI
 	 */
 
 	public function setMapType($mapType) {
@@ -408,7 +410,7 @@ 
 	 *
 	 * @param boolean $displayDirectionFields display directions or not in the info window
 	 *
-	 * @return void
+	 * @return MapAPI
 	 */
 
 	public function setDisplayDirectionFields($displayDirectionFields) {
@@ -421,7 +423,7 @@ 
 	 *
 	 * @param boolean $defaultHideMarker hide all the markers on the map by default
 	 *
-	 * @return void
+	 * @return MapAPI
 	 */
 
 	public function setDefaultHideMarker($defaultHideMarker) {
@@ -505,7 +507,7 @@ 
 	 * @param string  $category marker category
 	 * @param string  $icon     an icon url
 	 *
-	 * @return void
+	 * @return MapAPI
 	 */
 
 	public function addMarkerByCoords($lat, $lng, $html='', $category='', $icon='') {
@@ -529,7 +531,7 @@ 
 	 * @param string  $category marker category
 	 * @param string  $icon     an icon url
 	 *
-	 * @return void
+	 * @return MapAPI
 	 */
 
 	public function addMarkerByAddress($address, $content='', $category='', $icon='') {
@@ -549,7 +551,7 @@ 
 	 * @param string  $category marker category
 	 * @param string  $icon     an icon url
 	 *
-	 * @return void
+	 * @return MapAPI
 	 */
 
 	public function addArrayMarkerByCoords($coordtab, $category='', $icon='') {
@@ -631,7 +633,7 @@ 
 	 * @param string  $category marker category
 	 * @param string  $icon     an icon url
 	 *
-	 * @return void
+	 * @return MapAPI
 	 */
 
 	public function addArrayMarkerByAddress($coordtab, $category='', $icon='') {
@@ -660,7 +662,7 @@ 
 	 *
 	 * @param string  $url      url of the kml file compatible with gmap and gearth
 	 *
-	 * @return void
+	 * @return MapAPI
 	 */
 
 	public function addKML($url) {
@@ -820,6 +822,10 @@ 
 		return $result;
 	}
 
+	/**
+	 * @param string $templateName
+	 * @param ArrayData $templateVariables
+	 */
 	function processTemplateHTML($templateName, $templateVariables = null ) {
 		if (!$templateVariables) {
 			$templateVariables = new ArrayList();