From 7ddd9521b3f3a397da3b0a6b56238d31414eb4be Mon Sep 17 00:00:00 2001
From: brettp <brettp@36083f99-b078-4883-b0ff-0f9b5a30f544>
Date: Thu, 28 Oct 2010 19:17:36 +0000
Subject: Standardized code in all of core, not including language files,
 tests, or core mods.

git-svn-id: http://code.elgg.org/elgg/trunk@7124 36083f99-b078-4883-b0ff-0f9b5a30f544
---
 engine/classes/Notable.php | 25 ++++++++++++++++++-------
 1 file changed, 18 insertions(+), 7 deletions(-)

(limited to 'engine/classes/Notable.php')

diff --git a/engine/classes/Notable.php b/engine/classes/Notable.php
index ae88b521f..e36699dfc 100644
--- a/engine/classes/Notable.php
+++ b/engine/classes/Notable.php
@@ -2,29 +2,40 @@
 /**
  * Calendar interface for events.
  *
+ * @package    Elgg.Core
+ * @subpackage DataModel.Notable
+ *
+ * @todo Implement or remove.
  */
 interface Notable {
 	/**
 	 * Calendar functionality.
 	 * This function sets the time of an object on a calendar listing.
 	 *
-	 * @param int $hour If ommitted, now is assumed.
-	 * @param int $minute If ommitted, now is assumed.
-	 * @param int $second If ommitted, now is assumed.
-	 * @param int $day If ommitted, now is assumed.
-	 * @param int $month If ommitted, now is assumed.
-	 * @param int $year If ommitted, now is assumed.
+	 * @param int $hour     If ommitted, now is assumed.
+	 * @param int $minute   If ommitted, now is assumed.
+	 * @param int $second   If ommitted, now is assumed.
+	 * @param int $day      If ommitted, now is assumed.
+	 * @param int $month    If ommitted, now is assumed.
+	 * @param int $year     If ommitted, now is assumed.
 	 * @param int $duration Duration of event, remainder of the day is assumed.
+	 *
+	 * @return bool
 	 */
-	public function setCalendarTimeAndDuration($hour = NULL, $minute = NULL, $second = NULL, $day = NULL, $month = NULL, $year = NULL, $duration = NULL);
+	public function setCalendarTimeAndDuration($hour = NULL, $minute = NULL, $second = NULL,
+		$day = NULL, $month = NULL, $year = NULL, $duration = NULL);
 
 	/**
 	 * Return the start timestamp.
+	 *
+	 * @return int
 	 */
 	public function getCalendarStartTime();
 
 	/**
 	 * Return the end timestamp.
+	 *
+	 * @return int
 	 */
 	public function getCalendarEndTime();
 }
\ No newline at end of file
-- 
cgit v1.2.3