JeroenDeDauw / Maps

includes/Geocoders.php

Doc Comments +7 added lines, -4 removed lines

@@ -124,7 +124,7 @@ 
 	 * @param string $geoService
 	 * @param boolean $checkForCoords
 	 *
-	 * @return LatLongValue|false
+	 * @return LatLongValue
 	 */
 	public static function attemptToGeocode( $coordsOrAddress, $geoService = '', $checkForCoords = true ) {
 		if ( $checkForCoords ) {
@@ -150,7 +150,7 @@ 
 	 * @param string $address
 	 * @param string $geoService
 	 *
-	 * @return LatLongValue|false
+	 * @return LatLongValue
 	 * @throws MWException
 	 */
 	public static function geocode( $address, $geoService = '' ) {
@@ -190,6 +190,9 @@ 
 		return $coordinates;
 	}
 
+	/**
+	 * @param string $address
+	 */
 	private static function getGeocoded( Geocoder $geocoder, $address ) {
 		$coordinates = self::getGeocodedAsArray( $geocoder, $address );
 
@@ -260,7 +263,7 @@ 
 	 * @since 0.7
 	 *
 	 * @param string $geocoderIdentifier
-	 * @param string|\Maps\Geocoders\Geocoder $geocoder
+	 * @param string $geocoder
 	 */
 	public static function registerGeocoder( $geocoderIdentifier, $geocoder ) {
 		self::$registeredGeocoders[$geocoderIdentifier] = $geocoder;
@@ -331,7 +334,7 @@ 
 	 *
 	 * @param string $geocoderIdentifier
 	 *
-	 * @return string|bool
+	 * @return string
 	 * @throws MWException
 	 */
 	private static function getValidGeocoderIdentifier( $geocoderIdentifier ) {

includes/parsers/LineParser.php

Doc Comments +4 added lines, -1 removed lines

@@ -128,6 +128,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $link
+	 */
 	protected function setLinkFromParameter( Line &$line , $link ) {
 		if ( filter_var( $link , FILTER_VALIDATE_URL , FILTER_FLAG_SCHEME_REQUIRED ) ) {
 			$line->setLink( $link );
@@ -141,7 +144,7 @@ 
 	 * Checks if a string is prefixed with link:
 	 * @static
 	 * @param $link
-	 * @return bool|string
+	 * @return string|false
 	 * @since 2.0
 	 */
 	private function isLinkParameter( $link ) {

src/Geocoders/GeoNamesGeocoder.php

Doc Comments +7 added lines

@@ -17,6 +17,9 @@ 
 	private $fileFetcher;
 	private $geoNamesUser;
 
+	/**
+	 * @param string $geoNamesUser
+	 */
 	public function __construct( FileFetcher $fileFetcher, $geoNamesUser ) {
 		$this->fileFetcher = $fileFetcher;
 		$this->geoNamesUser = $geoNamesUser;
@@ -57,6 +60,10 @@ 
 			   . urlencode( $this->geoNamesUser );
 	}
 
+	/**
+	 * @param string $xml
+	 * @param string $tagName
+	 */
 	private function getXmlElementValue( $xml, $tagName ) {
 		$match = [];
 		preg_match( "/<$tagName>(.*?)<\/$tagName>/", $xml, $match );