From: Hannes Magnusson <bjori@php.net>
Date: Wed, 25 Oct 2006 12:35:16 +0000 (+0000)
Subject: Add oneliner descriptions
X-Git-Tag: RELEASE_1_0_0RC1~1209
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=641df597faefba0394b661b6235da47bc91b6868;p=php

Add oneliner descriptions
---

diff --git a/ext/date/php_date.c b/ext/date/php_date.c
index fb616cb678..041bfd54e0 100644
--- a/ext/date/php_date.c
+++ b/ext/date/php_date.c
@@ -1781,6 +1781,7 @@ static void date_initialize(php_date_obj *dateobj, /*const*/ char *time_str, int
 }
 
 /* {{{ proto DateTime date_create([string time[, DateTimeZone object]])
+   Returns new DateTime object
 */
 PHP_FUNCTION(date_create)
 {
@@ -1798,6 +1799,7 @@ PHP_FUNCTION(date_create)
 /* }}} */
 
 /* {{{ proto DateTime::__construct([string time[, DateTimeZone object]])
+   Creates new DateTime object
 */
 PHP_METHOD(DateTime, __construct)
 {
@@ -1814,6 +1816,7 @@ PHP_METHOD(DateTime, __construct)
 /* }}} */
 
 /* {{{ proto array date_parse(string date)
+   Returns associative array with detailed info about given date
 */
 PHP_FUNCTION(date_parse)
 {
@@ -1912,6 +1915,7 @@ PHP_FUNCTION(date_parse)
 /* }}} */
 
 /* {{{ proto string date_format(DateTime object, string format)
+   Returns date formatted according to given format
 */
 PHP_FUNCTION(date_format)
 {
@@ -1958,6 +1962,7 @@ PHP_FUNCTION(date_format_locale)
 /* }}} */
 
 /* {{{ proto void date_modify(DateTime object, string modify)
+   Alters the timestamp.
 */
 PHP_FUNCTION(date_modify)
 {
@@ -1992,6 +1997,7 @@ PHP_FUNCTION(date_modify)
 /* }}} */
 
 /* {{{ proto DateTimeZone date_timezone_get(DateTime object)
+   Return new DateTimeZone object relative to give DateTime
 */
 PHP_FUNCTION(date_timezone_get)
 {
@@ -2015,6 +2021,7 @@ PHP_FUNCTION(date_timezone_get)
 /* }}} */
 
 /* {{{ proto void date_timezone_set(DateTime object, DateTimeZone object)
+   Sets the timezone for the DateTime object.
 */
 PHP_FUNCTION(date_timezone_set)
 {
@@ -2038,6 +2045,7 @@ PHP_FUNCTION(date_timezone_set)
 /* }}} */
 
 /* {{{ proto long date_offset_get(DateTime object)
+   Returns the DST offset.
 */
 PHP_FUNCTION(date_offset_get)
 {
@@ -2062,6 +2070,7 @@ PHP_FUNCTION(date_offset_get)
 /* }}} */
 
 /* {{{ proto void date_time_set(DateTime object, long hour, long minute[, long second])
+   Sets the time.
 */
 PHP_FUNCTION(date_time_set)
 {
@@ -2082,6 +2091,7 @@ PHP_FUNCTION(date_time_set)
 /* }}} */
 
 /* {{{ proto void date_date_set(DateTime object, long year, long month, long day)
+   Sets the date.
 */
 PHP_FUNCTION(date_date_set)
 {
@@ -2102,6 +2112,7 @@ PHP_FUNCTION(date_date_set)
 /* }}} */
 
 /* {{{ proto void date_isodate_set(DateTime object, long year, long week[, long day])
+   Sets the ISO date.
 */
 PHP_FUNCTION(date_isodate_set)
 {
@@ -2145,6 +2156,7 @@ static int timezone_initialize(timelib_tzinfo **tzi, /*const*/ char *tz TSRMLS_D
 }
 
 /* {{{ proto DateTimeZone timezone_open(string timezone)
+   Returns new DateTimeZone object
 */
 PHP_FUNCTION(timezone_open)
 {
@@ -2163,6 +2175,7 @@ PHP_FUNCTION(timezone_open)
 /* }}} */
 
 /* {{{ proto DateTimeZone::__construct(string timezone)
+   Creates new DateTimeZone object.
 */
 PHP_METHOD(DateTimeZone, __construct)
 {
@@ -2181,6 +2194,7 @@ PHP_METHOD(DateTimeZone, __construct)
 /* }}} */
 
 /* {{{ proto string timezone_name_get(DateTimeZone object)
+   Returns the name of the timezone.
 */
 PHP_FUNCTION(timezone_name_get)
 {
@@ -2198,6 +2212,7 @@ PHP_FUNCTION(timezone_name_get)
 /* }}} */
 
 /* {{{ proto string timezone_name_from_abbr(string abbr[, long gmtOffset[, long isdst]])
+   Returns the timezone name from abbrevation
 */
 PHP_FUNCTION(timezone_name_from_abbr)
 {
@@ -2221,6 +2236,7 @@ PHP_FUNCTION(timezone_name_from_abbr)
 /* }}} */
 
 /* {{{ proto long timezone_offset_get(DateTimeZone object, DateTime object)
+   Returns the timezone offset.
 */
 PHP_FUNCTION(timezone_offset_get)
 {
@@ -2244,6 +2260,7 @@ PHP_FUNCTION(timezone_offset_get)
 /* }}} */
 
 /* {{{ proto array timezone_transitions_get(DateTimeZone object)
+   Returns numeracilly indexed array containing associative array for all transitions for the timezone.
 */
 PHP_FUNCTION(timezone_transitions_get)
 {
@@ -2273,6 +2290,7 @@ PHP_FUNCTION(timezone_transitions_get)
 /* }}} */
 
 /* {{{ proto array timezone_identifiers_list()
+   Returns numerically index array with all timezone identifiers.
 */
 PHP_FUNCTION(timezone_identifiers_list)
 {
@@ -2292,7 +2310,8 @@ PHP_FUNCTION(timezone_identifiers_list)
 }
 /* }}} */
 
-/* proto {{{ array timezone_abbreviations_list()
+/* {{{ proto array timezone_abbreviations_list()
+   Returns associative array containing dst, offset and the timezone name
 */
 PHP_FUNCTION(timezone_abbreviations_list)
 {