opencafe / datium

src/Convert.php

Doc Comments +4 added lines

@@ -63,6 +63,10 @@
    *
    *\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\
    */
+
+  /**
+   * @param \DateTime $date_time
+   */
   public function __construct( $date_time = NULL ) {
 
     if ( $date_time !== NULL ) {

src/Datium.php

Doc Comments +8 added lines, -4 removed lines

@@ -108,7 +108,7 @@ 
   /**
    * Get current datetime
    * @since Aug 17 2015
-   * @return object
+   * @return Datium
    */
   public static function now() {
 
@@ -126,7 +126,7 @@ 
    * @param $hour integer
    * @param $minute integer
    * @param $second integer
-   * @return object
+   * @return Datium
    */
   public static function create( $year = 2000, $month = 1, $day = 1, $hour = 0, $minute = 0, $second = 0 ) {
 
@@ -188,7 +188,7 @@ 
   /**
    * Add new date value to current date
    * @param $value string
-   * @return object
+   * @return Datium
    */
   public function add( $value ) {
 
@@ -221,7 +221,7 @@ 
 
   /**
    * Check if current year is leap or not
-   * @return boolean
+   * @return Leap
    */
   public function leap( $type = 'gr') {
 
@@ -261,6 +261,10 @@ 
 
   }
 
+  /**
+   * @param string $calendar
+   * @param string $format
+   */
   public function translate( $calendar, $format ) {
 
   $this->date_time = new Translate( $this->date_time, $calendar, $format, $this->gregorian_DayofWeek );

src/DayOf.php

Doc Comments +2 added lines, -2 removed lines

@@ -70,7 +70,7 @@ 
 
     /**
    * @since Sept, 14 2015
-   * @return integer
+   * @return double
    */
   protected function persian_day_of_year() {
 
@@ -93,7 +93,7 @@ 
 
      /**
    * @since Sept, 14 2015
-   * @return integer
+   * @return double
    */
   protected function islamic_day_of_year() {
 

src/Events/Events.php

Doc Comments +4 added lines

@@ -56,6 +56,10 @@
 	 *
 	 *\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/
 	 */
+
+	/**
+	 * @param string $path
+	 */
 	private function fetch( $path ) {
 
 		$this->events = include( $path );

src/Leap.php

Doc Comments +1 added lines, -1 removed lines

@@ -100,7 +100,7 @@
   /**
    * check the ghamari year is leap or not
    * @since Oct, 24 2015
-   * @return boolean
+   * @return integer|null
    */
   public function ghamariLeapYear() {
 

src/Translate.php

Doc Comments +3 added lines

@@ -20,6 +20,9 @@
 
   protected $english_number = array( '0', '1', '2', '3', '4', '5', '6', '7', '8', '9' );
 
+  /**
+   * @param \DateTime $date_time
+   */
   public function __construct( $date_time, $calendar, $format, $gregorian_DayofWeek ){
 
     $this->translate = include( 'lang/fa/general.php' );