http://www.mediawiki.org/wiki/Special:Code/MediaWiki/69118
Revision: 69118
Author: jeroendedauw
Date: 2010-07-06 23:39:51 +0000 (Tue, 06 Jul 2010)
Log Message:
-----------
Added docs
Modified Paths:
--------------
trunk/extensions/Maps/Includes/Maps_DistanceParser.php
Modified: trunk/extensions/Maps/Includes/Maps_DistanceParser.php
===================================================================
--- trunk/extensions/Maps/Includes/Maps_DistanceParser.php 2010-07-06
23:35:35 UTC (rev 69117)
+++ trunk/extensions/Maps/Includes/Maps_DistanceParser.php 2010-07-06
23:39:51 UTC (rev 69118)
@@ -18,6 +18,8 @@
*
* @ingroup Maps
*
+ * @since 0.6
+ *
* @author Jeroen De Dauw
*/
class MapsDistanceParser {
@@ -27,6 +29,8 @@
/**
* Parses a distance optionaly containing a unit to a float value in
meters.
*
+ * @since 0.6
+ *
* @param string $distance
*
* @return float The distance in meters.
@@ -48,6 +52,8 @@
/**
* Formats a given distance in meters to a distance in an optionaly
specified notation.
*
+ * @since 0.6
+ *
* @param float $meters
* @param string $unit
* @param integer $decimals
@@ -62,6 +68,8 @@
/**
* Shortcut for converting from one unit to another.
*
+ * @since 0.6
+ *
* @param string $distance
* @param string $unit
* @param integer $decimals
@@ -75,6 +83,8 @@
/**
* Returns if the provided string is a valid distance.
*
+ * @since 0.6
+ *
* @param string $distance
*
* @return boolean
@@ -86,6 +96,8 @@
/**
* Returns the unit to meter ratio in a safe way, by first resolving
the unit.
*
+ * @since 0.6.2
+ *
* @param string $unit
*
* @return float
@@ -98,6 +110,8 @@
/**
* Returns a valid unit. If the provided one is invalid, the default
will be used.
*
+ * @since 0.6.2
+ *
* @param string $unit
*
* @return string
@@ -124,6 +138,8 @@
/**
* Returns a list of all suported units.
*
+ * @since 0.6
+ *
* @return array
*/
public static function getUnits() {
_______________________________________________
MediaWiki-CVS mailing list
MediaWiki-CVS@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-cvs
