http://www.mediawiki.org/wiki/Special:Code/MediaWiki/69119
Revision: 69119
Author: jeroendedauw
Date: 2010-07-06 23:53:14 +0000 (Tue, 06 Jul 2010)
Log Message:
-----------
Added docs
Modified Paths:
--------------
trunk/extensions/Maps/Geocoders/Maps_BaseGeocoder.php
trunk/extensions/Maps/Includes/Maps_Mapper.php
trunk/extensions/Maps/Maps.php
Modified: trunk/extensions/Maps/Geocoders/Maps_BaseGeocoder.php
===================================================================
--- trunk/extensions/Maps/Geocoders/Maps_BaseGeocoder.php 2010-07-06
23:39:51 UTC (rev 69118)
+++ trunk/extensions/Maps/Geocoders/Maps_BaseGeocoder.php 2010-07-06
23:53:14 UTC (rev 69119)
@@ -1,7 +1,7 @@
<?php
/**
- * MapsBaseGeocoder is an abstract class inherited by the geocoding classes
+ * File holding the MapsBaseGeocoder class.
*
* @file Maps_BaseGeocoder.php
* @ingroup Maps
@@ -13,6 +13,14 @@
die( 'Not an entry point.' );
}
+/**
+ * MapsBaseGeocoder is an abstract class inherited by the geocoding classes.
+ *
+ * @ingroup Maps
+ * @since 0.2
+ *
+ * @author Jeroen De Dauw
+ */
abstract class MapsBaseGeocoder {
/**
@@ -20,7 +28,11 @@
* longitude (lon) of the provided address, or false in case the
* geocoding fails.
*
- * @param string $address
+ * @since 0.2
+ *
+ * @param $address String: the address to be geocoded
+ *
+ * @return string or false
*/
public static function geocode( $address ) {
return false; // This method needs to be overriden, if it's
not, return false.
@@ -29,7 +41,10 @@
/**
* Returns the content of the requested file, or false when the
connection fails
*
- * @param string $requestURL
+ * @since 0.2
+ *
+ * @param $requestURL String: the url to make the request to
+ *
* @return string or false
*/
protected static function GetResponse( $requestURL ) {
@@ -46,7 +61,8 @@
* Attempts to get the contents of a file via cURL request and
* returns it, or false when the attempt fails.
*
- * @param string $requestURL
+ * @param $requestURL String: the url to make the request to
+ *
* @return string or false
*/
protected static function GetCurlResponse( $requestURL ) {
Modified: trunk/extensions/Maps/Includes/Maps_Mapper.php
===================================================================
--- trunk/extensions/Maps/Includes/Maps_Mapper.php 2010-07-06 23:39:51 UTC
(rev 69118)
+++ trunk/extensions/Maps/Includes/Maps_Mapper.php 2010-07-06 23:53:14 UTC
(rev 69119)
@@ -12,6 +12,13 @@
die( 'Not an entry point.' );
}
+/**
+ * Class with generic mapping methods.
+ *
+ * @since 0.1
+ *
+ * @author Jeroen De Dauw
+ */
final class MapsMapper {
/**
@@ -306,4 +313,4 @@
),
);
}
-}
+}
\ No newline at end of file
Modified: trunk/extensions/Maps/Maps.php
===================================================================
--- trunk/extensions/Maps/Maps.php 2010-07-06 23:39:51 UTC (rev 69118)
+++ trunk/extensions/Maps/Maps.php 2010-07-06 23:53:14 UTC (rev 69119)
@@ -79,6 +79,8 @@
/**
* Initialization function for the Maps extension.
*
+ * @since 0.1
+ *
* @return true
*/
function efMapsSetup() {
@@ -142,6 +144,8 @@
/**
* Adds a link to Admin Links page.
*
+ * @since 0.2
+ *
* @return true
*/
function efMapsAddToAdminLinks( &$admin_links_tree ) {
_______________________________________________
MediaWiki-CVS mailing list
MediaWiki-CVS@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-cvs
