From bd4176288bbf28fb66706b6ab804a2a80492c574 Mon Sep 17 00:00:00 2001 From: Mehdi Achour Date: Sun, 30 Dec 2007 23:52:00 +0000 Subject: [PATCH] Switch to new doc style git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@249452 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/mcal/functions/mcal-day-of-week.xml | 46 ++++- reference/mcal/functions/mcal-day-of-year.xml | 47 ++++- .../mcal/functions/mcal-days-in-month.xml | 34 +++- .../functions/mcal-event-add-attribute.xml | 49 +++++- .../mcal/functions/mcal-event-set-end.xml | 84 ++++++++- .../functions/mcal-event-set-recur-daily.xml | 65 ++++++- .../mcal-event-set-recur-monthly-mday.xml | 66 ++++++- .../mcal-event-set-recur-monthly-wday.xml | 60 ++++++- .../functions/mcal-event-set-recur-weekly.xml | 72 +++++++- .../functions/mcal-event-set-recur-yearly.xml | 65 ++++++- .../mcal/functions/mcal-event-set-start.xml | 84 ++++++++- .../mcal-fetch-current-stream-event.xml | 166 +++++++++++++----- .../mcal/functions/mcal-next-recurrence.xml | 52 +++++- reference/mcrypt/functions/mcrypt-decrypt.xml | 91 +++++++--- .../functions/mcrypt-enc-get-modes-name.xml | 43 +++-- .../mcrypt/functions/mcrypt-generic-init.xml | 74 +++++--- reference/tidy/functions/tidy-get-release.xml | 14 +- 17 files changed, 921 insertions(+), 191 deletions(-) diff --git a/reference/mcal/functions/mcal-day-of-week.xml b/reference/mcal/functions/mcal-day-of-week.xml index 0ec34147ae..dc0ebd555e 100644 --- a/reference/mcal/functions/mcal-day-of-week.xml +++ b/reference/mcal/functions/mcal-day-of-week.xml @@ -1,13 +1,12 @@ - - + mcal_day_of_week Returns the day of the week of the given date - - Description + + &reftitle.description; intmcal_day_of_week intyear @@ -15,8 +14,43 @@ intday - mcal_day_of_week returns the day of the week - of the given date. + Returns the day of the week of the given date. + + + + &reftitle.parameters; + + + + year + + + The year. + + + + + month + + + The month. + + + + + day + + + The day. + + + + + + + + &reftitle.returnvalues; + Possible return values range from 0 for Sunday through 6 for Saturday. diff --git a/reference/mcal/functions/mcal-day-of-year.xml b/reference/mcal/functions/mcal-day-of-year.xml index 4e123aaa90..af390efc4d 100644 --- a/reference/mcal/functions/mcal-day-of-year.xml +++ b/reference/mcal/functions/mcal-day-of-year.xml @@ -1,13 +1,12 @@ - - + mcal_day_of_year Returns the day of the year of the given date - - Description + + &reftitle.description; intmcal_day_of_year intyear @@ -15,8 +14,44 @@ intday - mcal_day_of_year returns the day of the year - of the given date. + Returns the day of the year of the given date. + + + + &reftitle.parameters; + + + + year + + + The year. + + + + + month + + + The month. + + + + + day + + + The day. + + + + + + + + &reftitle.returnvalues; + + Returns the day as an integer. diff --git a/reference/mcal/functions/mcal-days-in-month.xml b/reference/mcal/functions/mcal-days-in-month.xml index e40622fbf7..41e4ab7294 100644 --- a/reference/mcal/functions/mcal-days-in-month.xml +++ b/reference/mcal/functions/mcal-days-in-month.xml @@ -1,13 +1,12 @@ - - + mcal_days_in_month Returns the number of days in a month - - Description + + &reftitle.description; intmcal_days_in_month intmonth @@ -19,6 +18,33 @@ considered year is a leap year or not. + + &reftitle.parameters; + + + + month + + + + + + + leap_year + + + + + + + + + + &reftitle.returnvalues; + + Returns the number of days in the month. + + - + mcal_event_add_attribute Adds an attribute and a value to the streams global event structure - - Description + + &reftitle.description; boolmcal_event_add_attribute intstream @@ -15,9 +14,45 @@ stringvalue - mcal_event_add_attribute adds an attribute - to the stream's global event structure with the value given by - "value". + Adds an attribute to the stream's global event structure with the given + value. + + + + &reftitle.parameters; + + + + stream + + + The MCAL stream. + + + + + attribute + + + The attribute name. + + + + + value + + + The attribute value. + + + + + + + + &reftitle.returnvalues; + + &return.success; diff --git a/reference/mcal/functions/mcal-event-set-end.xml b/reference/mcal/functions/mcal-event-set-end.xml index d16eae9648..66ed025f2c 100644 --- a/reference/mcal/functions/mcal-event-set-end.xml +++ b/reference/mcal/functions/mcal-event-set-end.xml @@ -1,13 +1,12 @@ - - + mcal_event_set_end Sets the end date and time of the streams global event structure - - Description + + &reftitle.description; voidmcal_event_set_end intstream @@ -15,12 +14,81 @@ intmonth intday inthour - intmin - intsec + intminutes + intseconds - mcal_event_set_end sets the streams global - event structure's end date and time to the given values. + Sets the streams global event structure's end date and time to the given + values. + + + + &reftitle.parameters; + + + + stream + + + The MCAL stream. + + + + + year + + + The year. + + + + + month + + + The month. + + + + + day + + + The day. + + + + + hour + + + The hour. + + + + + minutes + + + The minutes. + + + + + seconds + + + The seconds. + + + + + + + + &reftitle.returnvalues; + + &return.void; diff --git a/reference/mcal/functions/mcal-event-set-recur-daily.xml b/reference/mcal/functions/mcal-event-set-recur-daily.xml index d02c82b2c6..f602c9d0fa 100644 --- a/reference/mcal/functions/mcal-event-set-recur-daily.xml +++ b/reference/mcal/functions/mcal-event-set-recur-daily.xml @@ -1,13 +1,12 @@ - - + mcal_event_set_recur_daily Sets the recurrence of the streams global event structure - - Description + + &reftitle.description; voidmcal_event_set_recur_daily intstream @@ -17,9 +16,61 @@ intinterval - mcal_event_set_recur_daily sets the streams - global event structure's recurrence to the given value to be - reoccurring on a daily basis, ending at the given date. + Sets the streams global event structure's recurrence to the given value to + be reoccurring on a daily basis, ending at the given date. + + + + &reftitle.parameters; + + + + stream + + + The MCAL stream. + + + + + year + + + The year. + + + + + month + + + The month. + + + + + day + + + The day. + + + + + interval + + + The interval. + + + + + + + + &reftitle.returnvalues; + + &return.void; diff --git a/reference/mcal/functions/mcal-event-set-recur-monthly-mday.xml b/reference/mcal/functions/mcal-event-set-recur-monthly-mday.xml index defe409106..257a36e818 100644 --- a/reference/mcal/functions/mcal-event-set-recur-monthly-mday.xml +++ b/reference/mcal/functions/mcal-event-set-recur-monthly-mday.xml @@ -1,13 +1,12 @@ - - + mcal_event_set_recur_monthly_mday Sets the recurrence of the streams global event structure - - Description + + &reftitle.description; voidmcal_event_set_recur_monthly_mday intstream @@ -17,10 +16,61 @@ intinterval - mcal_event_set_recur_monthly_mday sets the - streams global event structure's recurrence to the given value to - be reoccurring on a monthly by month day basis, ending at the - given date. + Sets the streams global event structure's recurrence to the given value to + be reoccurring on a monthly by month day basis, ending at the given date. + + + + &reftitle.parameters; + + + + stream + + + The MCAL stream. + + + + + year + + + The year. + + + + + month + + + The month. + + + + + day + + + The day. + + + + + interval + + + The interval. + + + + + + + + &reftitle.returnvalues; + + &return.void; diff --git a/reference/mcal/functions/mcal-event-set-recur-monthly-wday.xml b/reference/mcal/functions/mcal-event-set-recur-monthly-wday.xml index 8c32e2c5c9..b24a591767 100644 --- a/reference/mcal/functions/mcal-event-set-recur-monthly-wday.xml +++ b/reference/mcal/functions/mcal-event-set-recur-monthly-wday.xml @@ -1,13 +1,12 @@ - - + mcal_event_set_recur_monthly_wday Sets the recurrence of the streams global event structure - - Description + + &reftitle.description; voidmcal_event_set_recur_monthly_wday intstream @@ -23,6 +22,59 @@ date. + + &reftitle.parameters; + + + + stream + + + The MCAL stream. + + + + + year + + + The year. + + + + + month + + + The month. + + + + + day + + + The day. + + + + + interval + + + The interval. + + + + + + + + &reftitle.returnvalues; + + &return.void; + + - + mcal_event_set_recur_weekly Sets the recurrence of the streams global event structure - - Description + + &reftitle.description; voidmcal_event_set_recur_weekly intstream @@ -18,9 +17,68 @@ intweekdays - mcal_event_set_recur_weekly sets the streams - global event structure's recurrence to the given value to be - reoccurring on a weekly basis, ending at the given date. + Sets the streams global event structure's recurrence to the given value to + be reoccurring on a weekly basis, ending at the given date. + + + + &reftitle.parameters; + + + + stream + + + The MCAL stream. + + + + + year + + + The year. + + + + + month + + + The month. + + + + + day + + + The day. + + + + + interval + + + The interval. + + + + + weekdays + + + + + + + + + + &reftitle.returnvalues; + + &return.void; diff --git a/reference/mcal/functions/mcal-event-set-recur-yearly.xml b/reference/mcal/functions/mcal-event-set-recur-yearly.xml index 9d9efb2a83..b2ee17fb58 100644 --- a/reference/mcal/functions/mcal-event-set-recur-yearly.xml +++ b/reference/mcal/functions/mcal-event-set-recur-yearly.xml @@ -1,13 +1,12 @@ - - + mcal_event_set_recur_yearly Sets the recurrence of the streams global event structure - - Description + + &reftitle.description; voidmcal_event_set_recur_yearly intstream @@ -17,9 +16,61 @@ intinterval - mcal_event_set_recur_yearly sets the streams - global event structure's recurrence to the given value to be - reoccurring on a yearly basis,ending at the given date. + Sets the streams global event structure's recurrence to the given value to + be reoccurring on a yearly basis,ending at the given date. + + + + &reftitle.parameters; + + + + stream + + + The MCAL stream. + + + + + year + + + The year. + + + + + month + + + The month. + + + + + day + + + The day. + + + + + interval + + + The interval. + + + + + + + + &reftitle.returnvalues; + + &return.void; diff --git a/reference/mcal/functions/mcal-event-set-start.xml b/reference/mcal/functions/mcal-event-set-start.xml index 6e16668893..f50dfba112 100644 --- a/reference/mcal/functions/mcal-event-set-start.xml +++ b/reference/mcal/functions/mcal-event-set-start.xml @@ -1,13 +1,12 @@ - - + mcal_event_set_start Sets the start date and time of the streams global event structure - - Description + + &reftitle.description; voidmcal_event_set_start intstream @@ -15,12 +14,81 @@ intmonth intday inthour - intmin - intsec + intminutes + intseconds - mcal_event_set_start sets the streams global - event structure's start date and time to the given values. + Sets the streams global event structure's start date and time to the given + values. + + + + &reftitle.parameters; + + + + stream + + + The MCAL stream. + + + + + year + + + The year. + + + + + month + + + The month. + + + + + day + + + The day. + + + + + hour + + + The hour. + + + + + minutes + + + The minutes. + + + + + seconds + + + The seconds. + + + + + + + + &reftitle.returnvalues; + + &return.void; diff --git a/reference/mcal/functions/mcal-fetch-current-stream-event.xml b/reference/mcal/functions/mcal-fetch-current-stream-event.xml index b37ce59c4e..3f5c14104d 100644 --- a/reference/mcal/functions/mcal-fetch-current-stream-event.xml +++ b/reference/mcal/functions/mcal-fetch-current-stream-event.xml @@ -1,68 +1,140 @@ - - + mcal_fetch_current_stream_event Returns an object containing the current streams event structure - - Description + + &reftitle.description; objectmcal_fetch_current_stream_event intstream + + Returns an object containing the current streams event structure. + + + + &reftitle.parameters; + + + + stream + + + The MCAL stream. + + + + + + + + &reftitle.returnvalues; mcal_fetch_current_stream_event returns the current stream's event structure as an object containing: - - - int id - ID of that event. - - int public - &true; if the event if public, &false; if it is - private. - - string category - Category string of the event. - - string title - Title string of the event. - - string description - Description string of the event. - - int alarm - number of minutes before the event to send an - alarm/reminder. - - object start - Object containing a datetime entry. - - object end - Object containing a datetime entry. - - int recur_type - recurrence type - - int recur_interval - recurrence interval - - datetime recur_enddate - recurrence end date - - int recur_data - recurrence data + + + int id - ID of that event. + + + + + int public - &true; if the event if public, &false; if it is private. + + + + + string category - Category string of the event. + + + + + string title - Title string of the event. + + + + + string description - Description string of the event. + + + + + int alarm - number of minutes before the event to send an alarm/reminder. + + + + + object start - Object containing a datetime entry. + + + + + object end - Object containing a datetime entry. + + + + + int recur_type - recurrence type + + + + + int recur_interval - recurrence interval + + + + + datetime recur_enddate - recurrence end date + + + + + int recur_data - recurrence data + + - All datetime entries consist of an object that contains: - - - int year - year - - int month - month - - int mday - day of month - - int hour - hour - - int min - minutes - - int sec - seconds - - int alarm - minutes before event to send an alarm + + + int year - year + + + + + int month - month + + + + + int mday - day of month + + + + + int hour - hour + + + + + int min - minutes + + + + + int sec - seconds + + + + + int alarm - minutes before event to send an alarm + + diff --git a/reference/mcal/functions/mcal-next-recurrence.xml b/reference/mcal/functions/mcal-next-recurrence.xml index b8fb5fb15d..3943650a00 100644 --- a/reference/mcal/functions/mcal-next-recurrence.xml +++ b/reference/mcal/functions/mcal-next-recurrence.xml @@ -1,13 +1,12 @@ - - + mcal_next_recurrence Returns the next recurrence of the event - - Description + + &reftitle.description; objectmcal_next_recurrence intstream @@ -15,11 +14,46 @@ arraynext - mcal_next_recurrence returns an object - filled with the next date the event occurs, on or after the - supplied date. Returns empty date field if event does not occur - or something is invalid. Uses weekstart to determine what day is - considered the beginning of the week. + Gets the next recurrence of the event. + + + + &reftitle.parameters; + + + + stream + + + The MCAL stream. + + + + + weekstart + + + Uses weekstart to determine what day is considered the beginning of + the week. + + + + + next + + + + + + + + + + &reftitle.returnvalues; + + Returns an object filled with the next date the event occurs, on or after + the supplied date. Returns empty date field if event does not occur or + something is invalid. diff --git a/reference/mcrypt/functions/mcrypt-decrypt.xml b/reference/mcrypt/functions/mcrypt-decrypt.xml index ffc675c69a..82ea225eab 100644 --- a/reference/mcrypt/functions/mcrypt-decrypt.xml +++ b/reference/mcrypt/functions/mcrypt-decrypt.xml @@ -1,13 +1,12 @@ - - + mcrypt_decrypt Decrypts crypttext with given parameters - - Description + + &reftitle.description; stringmcrypt_decrypt stringcipher @@ -17,34 +16,70 @@ stringiv - mcrypt_decrypt decrypts the data - and returns the unencrypted data. + Decrypts the data and returns the unencrypted data. + + + &reftitle.parameters; - Cipher is one of the MCRYPT_ciphername - constants of the name of the algorithm as string. + + + cipher + + + cipher is one of the MCRYPT_ciphername constants + of the name of the algorithm as string. + + + + + key + + + key is the key with which the data is encrypted. + If it's smaller that the required keysize, it is padded with + '\0'. + + + + + data + + + data is the data that will be decrypted with + the given cipher and mode. If the size of the data is not n * blocksize, + the data will be padded with '\0'. + + + + + mode + + + mode is one of the MCRYPT_MODE_modename + constants of one of "ecb", "cbc", "cfb", "ofb", "nofb" or "stream". + + + + + iv + + + The iv parameter is used for the initialisation + in CBC, CFB, OFB modes, and in some algorithms in STREAM mode. If you + do not supply an IV, while it is needed for an algorithm, the function + issues a warning and uses an IV with all bytes set to + '\0'. + + + + + + + &reftitle.returnvalues; - Key is the key with which the data - is encrypted. If it's smaller that the required keysize, it - is padded with '\0'. - - - Data is the data that will be decrypted - with the given cipher and mode. If the size of the data is not - n * blocksize, the data will be padded with '\0'. - - - Mode is one of the MCRYPT_MODE_modename - constants of one of "ecb", "cbc", "cfb", "ofb", "nofb" or - "stream". - - - The IV parameter is used for the - initialisation in CBC, CFB, OFB modes, and in some algorithms - in STREAM mode. If you do not supply an IV, while it is needed - for an algorithm, the function issues a warning and uses an - IV with all bytes set to '\0'. + Returns the decrypted data as a string. diff --git a/reference/mcrypt/functions/mcrypt-enc-get-modes-name.xml b/reference/mcrypt/functions/mcrypt-enc-get-modes-name.xml index f9b4e648bf..0aeb5f2a00 100644 --- a/reference/mcrypt/functions/mcrypt-enc-get-modes-name.xml +++ b/reference/mcrypt/functions/mcrypt-enc-get-modes-name.xml @@ -1,13 +1,12 @@ - - + mcrypt_enc_get_modes_name Returns the name of the opened mode - - Description + + &reftitle.description; stringmcrypt_enc_get_modes_name resourcetd @@ -15,23 +14,45 @@ This function returns the name of the mode. + + + &reftitle.parameters; + + + + td + + + The encryption descriptior. + + + + + + + + &reftitle.returnvalues; + + Returns the name as a string. + + + + &reftitle.examples; <function>mcrypt_enc_get_modes_name</function> example ]]> - - Prints: - + &example.outputs; - - + mcrypt_generic_init This function initializes all buffers needed for encryption - - Description + + &reftitle.description; intmcrypt_generic_init resourcetd @@ -15,17 +14,52 @@ stringiv - The maximum length of the key should be the one obtained by - calling mcrypt_enc_get_key_size and every - value smaller than this is legal. The IV should normally have - the size of the algorithms block size, but you must obtain the - size by calling mcrypt_enc_get_iv_size. - IV is ignored in ECB. IV MUST exist in CFB, CBC, STREAM, nOFB - and OFB modes. It needs to be random and unique (but not secret). - The same IV must be used for encryption/decryption. If you do not - want to use it you should set it to zeros, but this is not - recommended. + You need to call this function before every call to + mcrypt_generic or + mdecrypt_generic. + + + &reftitle.parameters; + + + + td + + + The encryption descriptior. + + + + + key + + + The maximum length of the key should be the one obtained by calling + mcrypt_enc_get_key_size and every value smaller + than this is legal. + + + + + iv + + + The IV should normally have the size of the algorithms block size, but + you must obtain the size by calling + mcrypt_enc_get_iv_size. IV is ignored in ECB. IV + MUST exist in CFB, CBC, STREAM, nOFB and OFB modes. It needs to be + random and unique (but not secret). The same IV must be used for + encryption/decryption. If you do not want to use it you should set it + to zeros, but this is not recommended. + + + + + + + + &reftitle.returnvalues; The function returns a negative value on error, -3 when the key length was incorrect, -4 when there was a memory allocation problem and any @@ -33,13 +67,13 @@ be displayed accordingly. &false; is returned if incorrect parameters were passed. + + + &reftitle.seealso; - You need to call this function before every call to - mcrypt_generic or - mdecrypt_generic. - - - See for an example mcrypt_module_open. + + mcrypt_module_open + diff --git a/reference/tidy/functions/tidy-get-release.xml b/reference/tidy/functions/tidy-get-release.xml index f79c2e2135..ac5325a2e2 100644 --- a/reference/tidy/functions/tidy-get-release.xml +++ b/reference/tidy/functions/tidy-get-release.xml @@ -1,12 +1,12 @@ - + tidy_get_release Get release date (version) for Tidy library - - Description + + &reftitle.description; Procedural style: stringtidy_get_release @@ -18,7 +18,13 @@ - This function returns a string with the release date of the Tidy library. + Gets the release date of the Tidy library. + + + + &reftitle.returnvalues; + + Returns a string with the release date of the Tidy library.