opencafe / datium

src/Datium.php

Doc Comments +11 added lines, -12 removed lines

@@ -193,7 +193,7 @@ 
      * Get current datetime
      *
      * @since  Aug 17 2015
-     * @return object
+     * @return Datium
      */
     public static function now()
     {
@@ -232,7 +232,7 @@ 
      * @param integer $minute minute number
      * @param integer $second second number
      *
-     * @return object
+     * @return Datium
      */
     public static function create(
         $year = 2000,
@@ -272,7 +272,7 @@ 
      *
      * @param  timestamp $timestamp Input timestamp value
      *
-     * @return object
+     * @return Datium
      */
     public static function createTimestamp($timestamp)
     {
@@ -300,7 +300,7 @@ 
      * @param object $date_start Start of the DateTime
      * @param object $date_end   End of the DateTime
      *
-     * @return object
+     * @return Datium
      */
     public static function between($date_start, $date_end)
     {
@@ -346,7 +346,7 @@ 
      *
      * @param object $calendar Assigned calendar to when calendar should start.
      *
-     * @return object
+     * @return Datium
      */
     public function to($calendar)
     {
@@ -402,7 +402,7 @@ 
      *
      * @param string $value How much date should be added to current date
      *
-     * @return object
+     * @return Datium
      */
     public function add($value)
     {
@@ -444,7 +444,7 @@ 
      *
      * @param string $value How much date should increase from current date
      *
-     * @return obejct
+     * @return Datium
      */
     public function sub($value)
     {
@@ -484,9 +484,8 @@ 
     /**
      * Check if current year is leap or not
      *
-     * @param string $type Name of the calendar to caculate leap year
      *
-     * @return boolean
+     * @return Leap
      */
     public function leap()
     {
@@ -502,7 +501,7 @@ 
      *
      * @since Aug, 22 2015
      *
-     * @return integer
+     * @return DayOf
      */
     public function dayOf()
     {
@@ -549,7 +548,7 @@ 
      *
      * @param string $language language short name fa, en, ar ...
      *
-     * @return object
+     * @return Datium
      */
     public function lang($language = 'fa')
     {
@@ -569,7 +568,7 @@ 
     /**
      * Return object as timestamp
      *
-     * @return timestamp
+     * @return integer
      */
     public function timestamp()
     {

src/SimpleDiff.php

Doc Comments +4 added lines, -3 removed lines

@@ -34,8 +34,9 @@ 
     /**
     * SimpleDiff Class constructure
     *
-    * @param DateTime $time_difference The time to calculate with now
-    * @param string $lang Language
+    * @param DateTime $difference The time to calculate with now
+    * @param \DateTime $start
+    * @param \DateTime $end
     */
     public function __construct($start, $end, $difference )
     {
@@ -65,8 +66,8 @@ 
     /**
     * Read ago config file
     *
-    * @param integer $date date index in ago config file
     * @param string $type duration type on ago config file
+    * @param integer $value
     */
     public function read( $value, $type )
     {

Indentation +24 added lines, -24 removed lines

@@ -32,11 +32,11 @@ 
     private $blockList;
 
     /**
-    * SimpleDiff Class constructure
-    *
-    * @param DateTime $time_difference The time to calculate with now
-    * @param string $lang Language
-    */
+     * SimpleDiff Class constructure
+     *
+     * @param DateTime $time_difference The time to calculate with now
+     * @param string $lang Language
+     */
     public function __construct($start, $end, $difference )
     {
 
@@ -51,10 +51,10 @@ 
     }
 
     /**
-    * Return difference period as an object
-    *
-    * @return object
-    */
+     * Return difference period as an object
+     *
+     * @return object
+     */
     public function all()
     {
 
@@ -63,11 +63,11 @@ 
     }
 
     /**
-    * Read ago config file
-    *
-    * @param integer $date date index in ago config file
-    * @param string $type duration type on ago config file
-    */
+     * Read ago config file
+     *
+     * @param integer $date date index in ago config file
+     * @param string $type duration type on ago config file
+     */
     public function read( $value, $type )
     {
 
@@ -98,7 +98,7 @@ 
       if( array_key_exists( $value, $config[ $type ] ) ) {
 
         $str = Lang::get( $this->language, $config[ $type ][ $value ] )
-               . $time;
+                . $time;
 
         return $str;
 
@@ -114,11 +114,11 @@ 
     }
 
     /**
-    * Show priority of duration
-    *
-    * @param integer $date date index in ago config file
-    * @param string $type duration type on ago config file
-    */
+     * Show priority of duration
+     *
+     * @param integer $date date index in ago config file
+     * @param string $type duration type on ago config file
+     */
     public function priority( $date, $type )
     {
 
@@ -144,10 +144,10 @@ 
     }
 
     /**
-    * Return fainal SimpleDiff result
-    *
-    * @return string
-    */
+     * Return fainal SimpleDiff result
+     *
+     * @return string
+     */
     public function get()
     {