diff --git a/reference/mcal/functions/mcal-append-event.xml b/reference/mcal/functions/mcal-append-event.xml index 0c40150870..3d60579eaa 100644 --- a/reference/mcal/functions/mcal-append-event.xml +++ b/reference/mcal/functions/mcal-append-event.xml @@ -1,13 +1,12 @@ - - + mcal_append_event Store a new event into an MCAL calendar - - Description + + &reftitle.description; intmcal_append_event intmcal_stream @@ -16,6 +15,24 @@ mcal_append_event stores the global event into an MCAL calendar for the stream mcal_stream. + + + &reftitle.parameters; + + + + mcal_stream + + + The MCAL stream. + + + + + + + + &reftitle.returnvalues; Returns the id of the newly inserted event. diff --git a/reference/mcal/functions/mcal-close.xml b/reference/mcal/functions/mcal-close.xml index 22fba219b3..2503a87b4f 100644 --- a/reference/mcal/functions/mcal-close.xml +++ b/reference/mcal/functions/mcal-close.xml @@ -1,13 +1,12 @@ - - + mcal_close Close an MCAL stream - - Description + + &reftitle.description; boolmcal_close intmcal_stream @@ -17,6 +16,34 @@ Closes the given mcal stream. + + &reftitle.parameters; + + + + stream + + + The MCAL stream. + + + + + flags + + + + + + + + + + &reftitle.returnvalues; + + &return.success; + + - + mcal_create_calendar Create a new MCAL calendar - - Description + + &reftitle.description; boolmcal_create_calendar intstream @@ -17,6 +16,35 @@ Creates a new calendar named calendar. + + &reftitle.parameters; + + + + stream + + + The MCAL stream. + + + + + calendar + + + The calendar name. + + + + + + + + &reftitle.returnvalues; + + &return.success; + + - + mcal_date_valid Returns &true; if the given year, month, day is a valid date - - Description + + &reftitle.description; boolmcal_date_valid intyear @@ -15,8 +14,44 @@ intday - mcal_date_valid Returns &true; if the given - year, month and day is a valid date, &false; if not. + mcal_date_valid + + + + &reftitle.parameters; + + + + year + + + The year. + + + + + month + + + The month. + + + + + day + + + The day. + + + + + + + + &reftitle.returnvalues; + + Returns &true; if the given date is valid, &false; otherwise. diff --git a/reference/mcal/functions/mcal-delete-calendar.xml b/reference/mcal/functions/mcal-delete-calendar.xml index fc358e53df..44b3a0fdd0 100644 --- a/reference/mcal/functions/mcal-delete-calendar.xml +++ b/reference/mcal/functions/mcal-delete-calendar.xml @@ -1,13 +1,12 @@ - - + mcal_delete_calendar Delete an MCAL calendar - - Description + + &reftitle.description; boolmcal_delete_calendar intstream @@ -17,6 +16,35 @@ Deletes the calendar named calendar. + + &reftitle.parameters; + + + + stream + + + The MCAL stream. + + + + + calendar + + + The calendar name. + + + + + + + + &reftitle.returnvalues; + + &return.success; + + - + mcal_delete_event Delete an event from an MCAL calendar - - Description + + &reftitle.description; boolmcal_delete_event intmcal_stream @@ -17,6 +16,32 @@ mcal_delete_event deletes the calendar event specified by the event_id. + + + &reftitle.parameters; + + + + mcal_stream + + + The MCAL stream. + + + + + event_id + + + The event identifier. + + + + + + + + &reftitle.returnvalues; Returns &true;. diff --git a/reference/mcal/functions/mcal-event-init.xml b/reference/mcal/functions/mcal-event-init.xml index f23f24ce66..ce77a3b971 100644 --- a/reference/mcal/functions/mcal-event-init.xml +++ b/reference/mcal/functions/mcal-event-init.xml @@ -1,23 +1,43 @@ - - + mcal_event_init Initializes a streams global event structure - - Description + + &reftitle.description; voidmcal_event_init intstream mcal_event_init initializes a streams global - event structure. this effectively sets all elements of the + event structure. This effectively sets all elements of the structure to 0, or the default settings. + + &reftitle.parameters; + + + + stream + + + The MCAL stream. + + + + + + + + &reftitle.returnvalues; + + &return.void; + + - + mcal_event_set_category Sets the category of the streams global event structure - - Description + + &reftitle.description; voidmcal_event_set_category intstream @@ -18,6 +17,35 @@ global event structure's category to the given string. + + &reftitle.parameters; + + + + stream + + + The MCAL stream. + + + + + category + + + The category to be set. + + + + + + + + &reftitle.returnvalues; + + &return.void; + + - + mcal_event_set_recur_none Sets the recurrence of the streams global event structure - - Description + + &reftitle.description; voidmcal_event_set_recur_none intstream @@ -18,6 +17,27 @@ MCAL_RECUR_NONE). + + &reftitle.parameters; + + + + stream + + + The MCAL stream. + + + + + + + + &reftitle.returnvalues; + + &return.void; + + - + mcal_event_set_title Sets the title of the streams global event structure - - Description + + &reftitle.description; voidmcal_event_set_title intstream @@ -18,6 +17,35 @@ event structure's title to the given string. + + &reftitle.parameters; + + + + stream + + + The MCAL stream. + + + + + title + + + The new title. + + + + + + + + &reftitle.returnvalues; + + &return.void; + + - + mcal_expunge Deletes all events marked for being expunged - - Description + + &reftitle.description; boolmcal_expunge intstream @@ -17,6 +16,34 @@ been previously marked for deletion. + + &reftitle.parameters; + + + + stream + + + The MCAL stream. + + + + + flags + + + + + + + + + + &reftitle.returnvalues; + + &return.success; + + - + mcal_is_leap_year Returns if the given year is a leap year or not - - Description + + &reftitle.description; boolmcal_is_leap_year intyear - mcal_is_leap_year returns 1 if the given - year is a leap year, 0 if not. + mcal_is_leap_year tells if the given + year is a leap year, or not. + + + + &reftitle.parameters; + + + + year + + + The tested year. + + + + + + + + &reftitle.returnvalues; + + Returns &true; if the given year is a leap year, &false; otherwise. diff --git a/reference/mcal/functions/mcal-open.xml b/reference/mcal/functions/mcal-open.xml index 0715b342bb..222532b958 100644 --- a/reference/mcal/functions/mcal-open.xml +++ b/reference/mcal/functions/mcal-open.xml @@ -1,13 +1,12 @@ - - + mcal_open Opens up an MCAL connection - - Description + + &reftitle.description; intmcal_open stringcalendar @@ -15,15 +14,56 @@ stringpassword intoptions - - Returns an MCAL stream on success, &false; on error. - mcal_open opens up an MCAL connection to the - specified calendar store. If the optional - options is specified, passes the - options to that mailbox also. The streams - internal event structure is also initialized upon connection. + specified calendar store. + The streams internal event structure is also initialized upon connection. + + + + &reftitle.parameters; + + + + calendar + + + The MCAL calendar store. + + + + + username + + + The MCAL username. + + + + + password + + + The MCAL password. + + + + + options + + + If the optional options is specified, + passes the options to that mailbox also. + + + + + + + + &reftitle.returnvalues; + + Returns an MCAL stream on success, &false; on error. diff --git a/reference/mcal/functions/mcal-rename-calendar.xml b/reference/mcal/functions/mcal-rename-calendar.xml index 89e8cb102f..d1fe408aee 100644 --- a/reference/mcal/functions/mcal-rename-calendar.xml +++ b/reference/mcal/functions/mcal-rename-calendar.xml @@ -1,13 +1,12 @@ - - + mcal_rename_calendar Rename an MCAL calendar - - Description + + &reftitle.description; boolmcal_rename_calendar intstream @@ -19,6 +18,43 @@ new_name. + + &reftitle.parameters; + + + + stream + + + The MCAL stream. + + + + + old_name + + + The old name. + + + + + new_name + + + The new name. + + + + + + + + &reftitle.returnvalues; + + &return.success; + + - + mcal_reopen Reopens an MCAL connection - - Description + + &reftitle.description; boolmcal_reopen intmcal_stream @@ -18,10 +17,46 @@ Reopens an MCAL stream to a new calendar. - mcal_reopen reopens an MCAL connection to the - specified calendar store. If the optional - options is specified, passes the - options to that mailbox also. + mcal_reopen reopens an MCAL connection to the + specified calendar store. + + + + &reftitle.parameters; + + + + mcal_stream + + + The MCAL stream. + + + + + calendar + + + The calendar store. + + + + + options + + + If the optional options is specified, + passes the options to that mailbox also. + + + + + + + + &reftitle.returnvalues; + + &return.success; diff --git a/reference/mcal/functions/mcal-snooze.xml b/reference/mcal/functions/mcal-snooze.xml index 9ae5d6390d..1d36858ecd 100644 --- a/reference/mcal/functions/mcal-snooze.xml +++ b/reference/mcal/functions/mcal-snooze.xml @@ -1,23 +1,47 @@ - - + mcal_snooze Turn off an alarm for an event - - Description + + &reftitle.description; boolmcal_snooze intstream_id intevent_id - mcal_snooze turns off an alarm for a - calendar event specified by the stream_id and - event_id. + mcal_snooze turns off an alarm for a the given + calendar event. + + + &reftitle.parameters; + + + + stream_id + + + The MCAL stream. + + + + + event_id + + + The event identifier. + + + + + + + + &reftitle.returnvalues; &return.success; diff --git a/reference/mcal/functions/mcal-store-event.xml b/reference/mcal/functions/mcal-store-event.xml index 19d7d9c29f..5f3e576688 100644 --- a/reference/mcal/functions/mcal-store-event.xml +++ b/reference/mcal/functions/mcal-store-event.xml @@ -1,13 +1,12 @@ - - + mcal_store_event Modify an existing event in an MCAL calendar - - Description + + &reftitle.description; intmcal_store_event intmcal_stream @@ -16,6 +15,24 @@ mcal_store_event stores the modifications to the current global event for the given stream. + + + &reftitle.parameters; + + + + mcal_stream + + + The MCAL stream. + + + + + + + + &reftitle.returnvalues; Returns the event id of the modified event on success and &false; on error. diff --git a/reference/mcal/functions/mcal-week-of-year.xml b/reference/mcal/functions/mcal-week-of-year.xml index 1a61d05a84..4436b19179 100644 --- a/reference/mcal/functions/mcal-week-of-year.xml +++ b/reference/mcal/functions/mcal-week-of-year.xml @@ -1,13 +1,12 @@ - - + mcal_week_of_year Returns the week number of the given date - - Description + + &reftitle.description; intmcal_week_of_year intday @@ -19,6 +18,43 @@ given date. + + &reftitle.parameters; + + + + day + + + The day. + + + + + month + + + The month. + + + + + year + + + The year. + + + + + + + + &reftitle.returnvalues; + + Returns the week number. + + + ob_tidyhandler ob_start callback function to repair the buffer - - Description + + &reftitle.description; stringob_tidyhandler stringinput @@ -16,6 +16,38 @@ ob_tidyhandler is intended to be used as a callback function for ob_start to repair the buffer. + + + &reftitle.parameters; + + + + input + + + The buffer. + + + + + mode + + + The buffer mode. + + + + + + + + &reftitle.returnvalues; + + Returns the modified buffer. + + + + &reftitle.examples; <function>ob_tidyhandler</function> example @@ -44,8 +76,13 @@ echo '

test'; + + + &reftitle.seealso; - See also ob_start. + + ob_start + diff --git a/reference/tidy/functions/tidy-access-count.xml b/reference/tidy/functions/tidy-access-count.xml index 1db1aa8d6e..f530d0effe 100644 --- a/reference/tidy/functions/tidy-access-count.xml +++ b/reference/tidy/functions/tidy-access-count.xml @@ -1,12 +1,12 @@ - + tidy_access_count Returns the Number of Tidy accessibility warnings encountered for specified document - - Description + + &reftitle.description; inttidy_access_count tidyobject @@ -15,15 +15,30 @@ tidy_access_count returns the number of accessibility warnings found for the specified document. - - - Due to the design of the TidyLib, you must call - tidy_diagnose before - tidy_access_count or it will return always - 0. You must also need to enable the - accessibility-check option. - - + + + &reftitle.parameters; + + + + object + + + The Tidy object. + + + + + + + + &reftitle.returnvalues; + + Returns the number of warnings. + + + + &reftitle.examples; <function>tidy_access_count</function> example @@ -57,9 +72,26 @@ echo tidy_access_count($tidy); //5 + + + &reftitle.notes; + + + Due to the design of the TidyLib, you must call + tidy_diagnose before + tidy_access_count or it will return always + 0. You must also need to enable the + accessibility-check option. + + + + + &reftitle.seealso; - See also tidy_error_count and - tidy_warning_count. + + tidy_error_count + tidy_warning_count + diff --git a/reference/tidy/functions/tidy-load-config.xml b/reference/tidy/functions/tidy-load-config.xml index 1017233fe6..6f4c5096d3 100644 --- a/reference/tidy/functions/tidy-load-config.xml +++ b/reference/tidy/functions/tidy-load-config.xml @@ -1,12 +1,12 @@ - + tidy_load_config Load an ASCII Tidy configuration file with the specified encoding - - Description + + &reftitle.description; voidtidy_load_config stringfilename @@ -16,6 +16,36 @@ This function loads a Tidy configuration file, with the specified encoding. + + + &reftitle.parameters; + + + + filename + + + + + + + encoding + + + + + + + + + + &reftitle.returnvalues; + + &return.void; + + + + &reftitle.notes; ¬e.tidy.1only; diff --git a/reference/tidy/functions/tidy-node-get-nodes.xml b/reference/tidy/functions/tidy-node-get-nodes.xml index 5c8733f67d..f77fc3e404 100644 --- a/reference/tidy/functions/tidy-node-get-nodes.xml +++ b/reference/tidy/functions/tidy-node-get-nodes.xml @@ -1,19 +1,17 @@ - + tidy_node->get_nodes Return an array of nodes under this node with the specified id - - Description + + &reftitle.description; arraytidy_node->get_nodes intnode_id - - &warn.undocumented.func; - + &warn.undocumented.func; diff --git a/reference/tidy/functions/tidy-set-encoding.xml b/reference/tidy/functions/tidy-set-encoding.xml index c80434f877..47053c4b46 100644 --- a/reference/tidy/functions/tidy-set-encoding.xml +++ b/reference/tidy/functions/tidy-set-encoding.xml @@ -1,23 +1,46 @@ - + tidy_set_encoding Set the input/output character encoding for parsing markup - - Description + + &reftitle.description; booltidy_set_encoding stringencoding - Sets the encoding for input/output documents. &return.success; - Possible values for encoding are - ascii, latin0, latin1, raw, utf8, iso2022, mac, win1252, ibm858, utf16, - utf16le, utf16be, big5 and shiftjis + Sets the encoding for input/output documents. - ¬e.tidy.1only; + + + &reftitle.parameters; + + + + encoding + + + Possible values for encoding are ascii, latin0, + latin1, raw, utf8, iso2022, mac, win1252, ibm858, utf16, utf16le, + utf16be, big5 and shiftjis. + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + &reftitle.notes; + ¬e.tidy.1only; diff --git a/reference/tidy/functions/tidy-warning-count.xml b/reference/tidy/functions/tidy-warning-count.xml index e496d16de7..886bb07e8a 100644 --- a/reference/tidy/functions/tidy-warning-count.xml +++ b/reference/tidy/functions/tidy-warning-count.xml @@ -1,12 +1,12 @@ - + tidy_warning_count Returns the Number of Tidy warnings encountered for specified document - - Description + + &reftitle.description; inttidy_warning_count tidyobject @@ -15,6 +15,30 @@ tidy_warning_count returns the number of Tidy warnings encountered for the specified document. + + + &reftitle.parameters; + + + + object + + + The Tidy object. + + + + + + + + &reftitle.returnvalues; + + Returns the number of warnings. + + + + &reftitle.examples; <function>tidy_warning_count</function> example @@ -33,9 +57,14 @@ echo tidy_warning_count($tidy) . "\n"; //5 + + + &reftitle.seealso; - See also tidy_access_count and - tidy_error_count. + + tidy_error_count + tidy_access_count +