gordonbanderson / Mappable

code/MapAPI.php

Doc Comments +28 added lines, -27 removed lines

@@ -212,7 +212,7 @@ 
 	 *
 	 * @param string  $googleMapKey the googleMapKey
 	 *
-	 * @return void
+	 * @return MapAPI
 	 */
 
 	public function setKey($googleMapKey) {
@@ -220,6 +220,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param boolean $inclusion
+	 */
 	public function setIncludeDownloadJavascript($inclusion) {
 		self::$include_download_javascript = $inclusion;
 		return $this;
@@ -253,13 +256,9 @@ 
 	 * Set the useClusterer parameter (optimization to display a lot of marker)
 	 *
 	 * @param boolean $useClusterer           use cluster or not
-	 * @param string  $clusterIcon            the cluster icon
-	 * @param int     $maxVisibleMarkers      max visible markers
 	 * @param int     $gridSize               grid size
-	 * @param int     $minMarkersPerClusterer minMarkersPerClusterer
-	 * @param int     $maxLinesPerInfoBox     maxLinesPerInfoBox
 	 *
-	 * @return void
+	 * @return MapAPI
 	 */
 
 	public function setClusterer($useClusterer, $gridSize=50, $maxZoom=17,
@@ -276,7 +275,7 @@ 
 	 *
 	 * @param string  $googleMapId the google div ID
 	 *
-	 * @return void
+	 * @return MapAPI
 	 */
 
 	public function setDivId($googleMapId) {
@@ -289,7 +288,7 @@ 
 	 *
 	 * @param string  $googleMapDirectionId GoogleMap  Direction ID for the HTML DIV
 	 *
-	 * @return void
+	 * @return MapAPI
 	 */
 
 	public function setDirectionDivId($googleMapDirectionId) {
@@ -304,7 +303,7 @@ 
 	 * @param int     $width  GoogleMap  width
 	 * @param int     $height GoogleMap  height
 	 *
-	 * @return void
+	 * @return MapAPI
 	 */
 
 	public function setSize($width, $height) {
@@ -320,7 +319,7 @@ 
 	 * @param int     $iconWidth  GoogleMap  marker icon width
 	 * @param int     $iconHeight GoogleMap  marker icon height
 	 *
-	 * @return void
+	 * @return MapAPI
 	 */
 
 	public function setIconSize($iconWidth, $iconHeight) {
@@ -334,7 +333,7 @@ 
 	 *
 	 * @param string  $lang GoogleMap  lang : fr,en,..
 	 *
-	 * @return void
+	 * @return MapAPI
 	 */
 
 	public function setLang($lang) {
@@ -347,7 +346,7 @@ 
 	 *
 	 * @param int     $zoom GoogleMap  zoom.
 	 *
-	 * @return void
+	 * @return MapAPI
 	 */
 
 	public function setZoom($zoom) {
@@ -358,9 +357,8 @@ 
 	/**
 	 * Set the zoom of the infowindow
 	 *
-	 * @param int     $zoom GoogleMap  zoom.
 	 *
-	 * @return void
+	 * @return MapAPI
 	 */
 
 	public function setInfoWindowZoom($infoWindowZoom) {
@@ -371,9 +369,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) {
@@ -384,9 +381,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) {
@@ -399,7 +396,7 @@ 
 	 *
 	 * @param string  $center GoogleMap  center (an address)
 	 *
-	 * @return void
+	 * @return MapAPI
 	 */
 
 	public function setCenter($center) {
@@ -412,7 +409,7 @@ 
 	 *
 	 * @param string  $mapType  Can be one of road,satellite,hybrid or terrain. Defaults to road
 	 *
-	 * @return void
+	 * @return MapAPI
 	 */
 
 	public function setMapType($mapType) {
@@ -458,7 +455,7 @@ 
 	 *
 	 * @param boolean $displayDirectionFields display directions or not in the info window
 	 *
-	 * @return void
+	 * @return MapAPI
 	 */
 
 	public function setDisplayDirectionFields($displayDirectionFields) {
@@ -471,7 +468,7 @@ 
 	 *
 	 * @param boolean $defaultHideMarker hide all the markers on the map by default
 	 *
-	 * @return void
+	 * @return MapAPI
 	 */
 
 	public function setDefaultHideMarker($defaultHideMarker) {
@@ -555,7 +552,7 @@ 
 	 * @param string  $category marker category
 	 * @param string  $icon     an icon url
 	 *
-	 * @return void
+	 * @return MapAPI
 	 */
 
 	public function addMarkerByCoords($lat, $lng, $html='', $category='', $icon='') {
@@ -579,7 +576,7 @@ 
 	 * @param string  $category marker category
 	 * @param string  $icon     an icon url
 	 *
-	 * @return void
+	 * @return MapAPI
 	 */
 
 	public function addMarkerByAddress($address, $content='', $category='', $icon='') {
@@ -599,7 +596,7 @@ 
 	 * @param string  $category marker category
 	 * @param string  $icon     an icon url
 	 *
-	 * @return void
+	 * @return MapAPI
 	 */
 
 	public function addArrayMarkerByCoords($coordtab, $category='', $icon='') {
@@ -681,7 +678,7 @@ 
 	 * @param string  $category marker category
 	 * @param string  $icon     an icon url
 	 *
-	 * @return void
+	 * @return MapAPI
 	 */
 
 	public function addArrayMarkerByAddress($coordtab, $category='', $icon='') {
@@ -710,7 +707,7 @@ 
 	 *
 	 * @param string  $url      url of the kml file compatible with gmap and gearth
 	 *
-	 * @return void
+	 * @return MapAPI
 	 */
 
 	public function addKML($url) {
@@ -870,6 +867,10 @@ 
 		return $result;
 	}
 
+	/**
+	 * @param string $templateName
+	 * @param ArrayData $templateVariables
+	 */
 	function processTemplateHTML($templateName, $templateVariables = null ) {
 		if (!$templateVariables) {
 			$templateVariables = new ArrayList();

code/MapExtension.php

Doc Comments +1 added lines, -1 removed lines

@@ -184,7 +184,7 @@
 
 	/**
 	 * Access the map editing field for the purpose of adding guide points
-	 * @return [LatLongField] instance of location editing field
+	 * @return FormField instance of location editing field
 	 */
 	public function getMapField() {
 		if (!isset($this->mapField)) {

code/LatLongField.php

Doc Comments +3 added lines

@@ -19,6 +19,9 @@
 
 	private static $ctr = 0;
 
+	/**
+	 * @param string[] $buttonText
+	 */
 	public function __construct($children = array(), $buttonText = null) {
 		self::$ctr++;
 

code/MapField.php

Doc Comments +4 added lines

@@ -10,6 +10,10 @@
 		protected $headingLevel = 2;
 		private $divId;
 
+		/**
+		 * @param string $name
+		 * @param string $title
+		 */
 		function __construct($name, $title = null, $headingLevel = 2, $allowHTML = false, $form = null) {
 			$this->divId = $name;
 				// legacy handling for old parameters: $title, $heading, ...

code/MapUtil.php

Doc Comments +4 added lines, -1 removed lines

@@ -79,6 +79,9 @@ 
 	}
 
 
+	/**
+	 * @param boolean $new_map_already_rendered
+	 */
 	public static function set_map_already_rendered($new_map_already_rendered) {
 		self::$map_already_rendered = $new_map_already_rendered;
 	}
@@ -155,7 +158,7 @@ 
 	/**
 	 * Get a new GoogleMapAPI object and load it with the default settings
 	 *
-	 * @return GoogleMapAPI
+	 * @return MapAPI
 	 */
 	public static function instance()
 	{