phpdoc
authorJan Schneider <jan@horde.org>
Thu, 5 Aug 2010 13:07:05 +0000 (15:07 +0200)
committerJan Schneider <jan@horde.org>
Mon, 9 Aug 2010 13:30:52 +0000 (15:30 +0200)
framework/Date/lib/Horde/Date.php

index 5ef2f20..d4e6635 100644 (file)
@@ -170,7 +170,7 @@ class Horde_Date
     protected $_formatCache = array();
 
     /**
-     * Build a new date object. If $date contains date parts, use them to
+     * Builds a new date object. If $date contains date parts, use them to
      * initialize the object.
      *
      * Recognized formats:
@@ -466,7 +466,7 @@ class Horde_Date
     }
 
     /**
-     * Add a number of seconds or units to this date, returning a new Date
+     * Adds a number of seconds or units to this date, returning a new Date
      * object.
      */
     public function add($factor)
@@ -484,7 +484,7 @@ class Horde_Date
     }
 
     /**
-     * Subtract a number of seconds or units from this date, returning a new
+     * Subtracts a number of seconds or units from this date, returning a new
      * Horde_Date object.
      */
     public function sub($factor)
@@ -523,7 +523,7 @@ class Horde_Date
     }
 
     /**
-     * Set the default date format used in __toString()
+     * Sets the default date format used in __toString()
      *
      * @param string $format
      */
@@ -587,7 +587,7 @@ class Horde_Date
     }
 
     /**
-     * Return the number of weeks in the given year (52 or 53).
+     * Returns the number of weeks in the given year (52 or 53).
      *
      * @param integer $year  The year to count the number of weeks in.
      *
@@ -604,7 +604,7 @@ class Horde_Date
     }
 
     /**
-     * Set the date of this object to the $nth weekday of $weekday.
+     * Sets the date of this object to the $nth weekday of $weekday.
      *
      * @param integer $weekday  The day of the week (0 = Sunday, etc).
      * @param integer $nth      The $nth $weekday to set to (defaults to 1).
@@ -637,7 +637,7 @@ class Horde_Date
     }
 
     /**
-     * Compare this date to another date object to see which one is
+     * Compares this date to another date object to see which one is
      * greater (later). Assumes that the dates are in the same
      * timezone.
      *
@@ -700,7 +700,7 @@ class Horde_Date
     }
 
     /**
-     * Compare this to another date object by time, to see which one
+     * Compares this to another date object by time, to see which one
      * is greater (later). Assumes that the dates are in the same
      * timezone.
      *
@@ -727,7 +727,7 @@ class Horde_Date
     }
 
     /**
-     * Compare this to another date object, including times, to see
+     * Compares this to another date object, including times, to see
      * which one is greater (later). Assumes that the dates are in the
      * same timezone.
      *
@@ -763,7 +763,7 @@ class Horde_Date
     }
 
     /**
-     * Get the time offset for local time zone.
+     * Returns the time offset for local time zone.
      *
      * @param boolean $colon  Place a colon between hours and minutes?
      *
@@ -775,7 +775,7 @@ class Horde_Date
     }
 
     /**
-     * Return the unix timestamp representation of this date.
+     * Returns the unix timestamp representation of this date.
      *
      * @return integer  A unix timestamp.
      */
@@ -789,7 +789,7 @@ class Horde_Date
     }
 
     /**
-     * Return the unix timestamp representation of this date, 12:00am.
+     * Returns the unix timestamp representation of this date, 12:00am.
      *
      * @return integer  A unix timestamp.
      */
@@ -803,7 +803,7 @@ class Horde_Date
     }
 
     /**
-     * Format date and time to be passed around as a short url parameter.
+     * Formats date and time to be passed around as a short url parameter.
      *
      * @return string  Date and time.
      */
@@ -813,7 +813,7 @@ class Horde_Date
     }
 
     /**
-     * Format date and time to the ISO format used by JSON.
+     * Formats date and time to the ISO format used by JSON.
      *
      * @return string  Date and time.
      */
@@ -859,7 +859,7 @@ class Horde_Date
     }
 
     /**
-     * Format date and time using strftime() format.
+     * Formats date and time using strftime() format.
      *
      * @return string  strftime() formatted date and time.
      */
@@ -873,7 +873,7 @@ class Horde_Date
     }
 
     /**
-     * Format date and time using a limited set of the strftime() format.
+     * Formats date and time using a limited set of the strftime() format.
      *
      * @return string  strftime() formatted date and time.
      */
@@ -926,7 +926,7 @@ class Horde_Date
     }
 
     /**
-     * Correct any over- or underflows in any of the date's members.
+     * Corrects any over- or underflows in any of the date's members.
      *
      * @param integer $mask  We may not want to correct some overflows.
      */
@@ -996,7 +996,7 @@ class Horde_Date
     }
 
     /**
-     * Handle args in order: year month day hour min sec tz
+     * Handles args in order: year month day hour min sec tz
      */
     protected function _initializeFromArgs($args)
     {