| Index: trunk/extensions/Maps/Includes/Maps_Mapper.php |
| — | — | @@ -12,6 +12,13 @@ |
| 13 | 13 | die( 'Not an entry point.' ); |
| 14 | 14 | } |
| 15 | 15 | |
| | 16 | +/** |
| | 17 | + * Class with generic mapping methods. |
| | 18 | + * |
| | 19 | + * @since 0.1 |
| | 20 | + * |
| | 21 | + * @author Jeroen De Dauw |
| | 22 | + */ |
| 16 | 23 | final class MapsMapper { |
| 17 | 24 | |
| 18 | 25 | /** |
| — | — | @@ -306,4 +313,4 @@ |
| 307 | 314 | ), |
| 308 | 315 | ); |
| 309 | 316 | } |
| 310 | | -} |
| | 317 | +} |
| \ No newline at end of file |
| Index: trunk/extensions/Maps/Maps.php |
| — | — | @@ -79,6 +79,8 @@ |
| 80 | 80 | /** |
| 81 | 81 | * Initialization function for the Maps extension. |
| 82 | 82 | * |
| | 83 | + * @since 0.1 |
| | 84 | + * |
| 83 | 85 | * @return true |
| 84 | 86 | */ |
| 85 | 87 | function efMapsSetup() { |
| — | — | @@ -142,6 +144,8 @@ |
| 143 | 145 | /** |
| 144 | 146 | * Adds a link to Admin Links page. |
| 145 | 147 | * |
| | 148 | + * @since 0.2 |
| | 149 | + * |
| 146 | 150 | * @return true |
| 147 | 151 | */ |
| 148 | 152 | function efMapsAddToAdminLinks( &$admin_links_tree ) { |
| Index: trunk/extensions/Maps/Geocoders/Maps_BaseGeocoder.php |
| — | — | @@ -1,7 +1,7 @@ |
| 2 | 2 | <?php |
| 3 | 3 | |
| 4 | 4 | /** |
| 5 | | - * MapsBaseGeocoder is an abstract class inherited by the geocoding classes |
| | 5 | + * File holding the MapsBaseGeocoder class. |
| 6 | 6 | * |
| 7 | 7 | * @file Maps_BaseGeocoder.php |
| 8 | 8 | * @ingroup Maps |
| — | — | @@ -13,6 +13,14 @@ |
| 14 | 14 | die( 'Not an entry point.' ); |
| 15 | 15 | } |
| 16 | 16 | |
| | 17 | +/** |
| | 18 | + * MapsBaseGeocoder is an abstract class inherited by the geocoding classes. |
| | 19 | + * |
| | 20 | + * @ingroup Maps |
| | 21 | + * @since 0.2 |
| | 22 | + * |
| | 23 | + * @author Jeroen De Dauw |
| | 24 | + */ |
| 17 | 25 | abstract class MapsBaseGeocoder { |
| 18 | 26 | |
| 19 | 27 | /** |
| — | — | @@ -20,7 +28,11 @@ |
| 21 | 29 | * longitude (lon) of the provided address, or false in case the |
| 22 | 30 | * geocoding fails. |
| 23 | 31 | * |
| 24 | | - * @param string $address |
| | 32 | + * @since 0.2 |
| | 33 | + * |
| | 34 | + * @param $address String: the address to be geocoded |
| | 35 | + * |
| | 36 | + * @return string or false |
| 25 | 37 | */ |
| 26 | 38 | public static function geocode( $address ) { |
| 27 | 39 | return false; // This method needs to be overriden, if it's not, return false. |
| — | — | @@ -29,7 +41,10 @@ |
| 30 | 42 | /** |
| 31 | 43 | * Returns the content of the requested file, or false when the connection fails |
| 32 | 44 | * |
| 33 | | - * @param string $requestURL |
| | 45 | + * @since 0.2 |
| | 46 | + * |
| | 47 | + * @param $requestURL String: the url to make the request to |
| | 48 | + * |
| 34 | 49 | * @return string or false |
| 35 | 50 | */ |
| 36 | 51 | protected static function GetResponse( $requestURL ) { |
| — | — | @@ -46,7 +61,8 @@ |
| 47 | 62 | * Attempts to get the contents of a file via cURL request and |
| 48 | 63 | * returns it, or false when the attempt fails. |
| 49 | 64 | * |
| 50 | | - * @param string $requestURL |
| | 65 | + * @param $requestURL String: the url to make the request to |
| | 66 | + * |
| 51 | 67 | * @return string or false |
| 52 | 68 | */ |
| 53 | 69 | protected static function GetCurlResponse( $requestURL ) { |