1 files changed, 49 insertions, 36 deletions
diff --git a/engine/classes/Locatable.php b/engine/classes/Locatable.php
index 5f52d8eab..7287d9798 100644
--- a/engine/classes/Locatable.php
+++ b/engine/classes/Locatable.php
@@ -1,36 +1,49 @@
-<?php
-
-/**
- * Define an interface for geo-tagging entities.
- *
- */
-interface Locatable {
-	/** Set a location text */
-	public function setLocation($location);
-
-	/**
-	 * Set latitude and longitude tags for a given entity.
-	 *
-	 * @param float $lat
-	 * @param float $long
-	 */
-	public function setLatLong($lat, $long);
-
-	/**
-	 * Get the contents of the ->geo:lat field.
-	 *
-	 */
-	public function getLatitude();
-
-	/**
-	 * Get the contents of the ->geo:lat field.
-	 *
-	 */
-	public function getLongitude();
-
-	/**
-	 * Get the ->location metadata.
-	 *
-	 */
-	public function getLocation();
-}
-\ No newline at end of file
+<?php
+
+/**
+ * Define an interface for geo-tagging entities.
+ *
+ * @package    Elgg.Core
+ * @subpackage SocialModel.Locatable
+ */
+interface Locatable {
+	/**
+	 * Set a location text
+	 *
+	 * @param string $location Textual representation of location
+	 *
+	 * @return bool
+	 */
+	public function setLocation($location);
+
+	/**
+	 * Set latitude and longitude tags for a given entity.
+	 *
+	 * @param float $lat  Latitude
+	 * @param float $long Longitude
+	 *
+	 * @return bool
+	 */
+	public function setLatLong($lat, $long);
+
+	/**
+	 * Get the contents of the ->geo:lat field.
+	 *
+	 * @return int
+	 */
+	public function getLatitude();
+
+	/**
+	 * Get the contents of the ->geo:lat field.
+	 *
+	 * @return int
+	 */
+	public function getLongitude();
+
+	/**
+	 * Get the ->location metadata.
+	 *
+	 * @return string
+	 */
+	public function getLocation();
+}