Separate constructorsynopsis from methodsynopsis.

Added missing procedural function prototypes to OOP methods.
Updated xi:includes to get OOP style constructor and methodsynopsis only.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@299350 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Richard Quadling 2010-05-13 15:33:37 +00:00
parent c8d0e68933
commit 1b93e89734
33 changed files with 75 additions and 52 deletions

View file

@ -35,7 +35,8 @@
<!-- }}} -->
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.dateinterval')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.dateinterval')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis)" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.dateinterval')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='oop'])" />
</classsynopsis>
<!-- }}} -->

View file

@ -9,10 +9,10 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<methodname>DateInterval::__construct</methodname>
<constructorsynopsis>
<modifier>public</modifier> <methodname>DateInterval::__construct</methodname>
<methodparam><type>string</type><parameter>interval_spec</parameter></methodparam>
</methodsynopsis>
</constructorsynopsis>
<para>
Creates new DateInterval object.
</para>

View file

@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<methodsynopsis role="oop">
<modifier>public</modifier> <modifier>static</modifier> <type>DateInterval</type><methodname>DateInterval::createFromDateString</methodname>
<methodparam><type>string</type><parameter>time</parameter></methodparam>
</methodsynopsis>

View file

@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<methodsynopsis role="oop">
<modifier>public</modifier> <type>string</type><methodname>DateInterval::format</methodname>
<methodparam><type>string</type><parameter>format</parameter></methodparam>
</methodsynopsis>

View file

@ -44,7 +44,7 @@
</fieldsynopsis>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.dateperiod')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.dateperiod')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[@role='oop'])" />
</classsynopsis>
<!-- }}} -->

View file

@ -9,25 +9,25 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<methodname>DatePeriod::__construct</methodname>
<constructorsynopsis role="oop">
<modifier>public</modifier> <methodname>DatePeriod::__construct</methodname>
<methodparam><type>DateTime</type><parameter>start</parameter></methodparam>
<methodparam><type>DateInterval</type><parameter>interval</parameter></methodparam>
<methodparam><type>int</type><parameter>recurrences</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<methodname>DatePeriod::__construct</methodname>
</constructorsynopsis>
<constructorsynopsis role="oop">
<modifier>public</modifier> <methodname>DatePeriod::__construct</methodname>
<methodparam><type>DateTime</type><parameter>start</parameter></methodparam>
<methodparam><type>DateInterval</type><parameter>interval</parameter></methodparam>
<methodparam><type>DateTime</type><parameter>end</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<methodname>DatePeriod::__construct</methodname>
</constructorsynopsis>
<constructorsynopsis role="oop">
<modifier>public</modifier> <methodname>DatePeriod::__construct</methodname>
<methodparam><type>string</type><parameter>isostr</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam>
</methodsynopsis>
</constructorsynopsis>
<para>
Creates new DatePeriod object.
</para>

View file

@ -100,7 +100,8 @@
</fieldsynopsis>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.datetime')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.datetime')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[@role='oop'])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.datetime')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='oop'])" />
</classsynopsis>
<!-- }}} -->

View file

@ -13,7 +13,7 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis>
<methodsynopsis role="oop">
<modifier>public</modifier> <type>DateTime</type><methodname>DateTime::add</methodname>
<methodparam><type>DateInterval</type><parameter>interval</parameter></methodparam>
</methodsynopsis>

View file

@ -10,13 +10,13 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis>
<methodname>DateTime::__construct</methodname>
<constructorsynopsis role="oop">
<modifier>public</modifier> <methodname>DateTime::__construct</methodname>
<methodparam choice="opt"><type>string</type><parameter>time</parameter><initializer>"now"</initializer></methodparam>
<methodparam choice="opt"><type>DateTimeZone</type><parameter>timezone</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
</constructorsynopsis>
<para>&style.procedural;</para>
<methodsynopsis>
<methodsynopsis role="procedural">
<type>DateTime</type><methodname>date_create</methodname>
<methodparam choice="opt"><type>string</type><parameter>time</parameter><initializer>"now"</initializer></methodparam>
<methodparam choice="opt"><type>DateTimeZone</type><parameter>timezone</parameter><initializer>&null;</initializer></methodparam>

View file

@ -10,7 +10,7 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis>
<methodsynopsis role="oop">
<modifier>public</modifier> <modifier>static</modifier> <type>DateTime</type><methodname>DateTime::createFromFormat</methodname>
<methodparam><type>string</type><parameter>format</parameter></methodparam>
<methodparam><type>string</type><parameter>time</parameter></methodparam>

View file

@ -10,7 +10,7 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis>
<methodsynopsis role="oop">
<modifier>public</modifier> <type>DateInterval</type><methodname>DateTime::diff</methodname>
<methodparam><type>DateTime</type><parameter>datetime2</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>absolute</parameter><initializer>false</initializer></methodparam>

View file

@ -10,7 +10,7 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis>
<methodsynopsis role="oop">
<modifier>public</modifier> <type>string</type><methodname>DateTime::format</methodname>
<methodparam><type>string</type><parameter>format</parameter></methodparam>
</methodsynopsis>

View file

@ -10,7 +10,7 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis>
<methodsynopsis role="oop">
<modifier>public</modifier> <modifier>static</modifier> <type>array</type><methodname>DateTime::getLastErrors</methodname>
<void />
</methodsynopsis>

View file

@ -10,7 +10,7 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis>
<methodsynopsis role="oop">
<modifier>public</modifier> <type>int</type><methodname>DateTime::getOffset</methodname>
<void />
</methodsynopsis>

View file

@ -10,7 +10,7 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis>
<methodsynopsis role="oop">
<modifier>public</modifier> <type>int</type><methodname>DateTime::getTimestamp</methodname>
<void />
</methodsynopsis>

View file

@ -10,7 +10,7 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis>
<methodsynopsis role="oop">
<modifier>public</modifier> <type>DateTimeZone</type><methodname>DateTime::getTimezone</methodname>
<void/>
</methodsynopsis>

View file

@ -10,7 +10,7 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis>
<methodsynopsis role="oop">
<modifier>public</modifier> <type>DateTime</type><methodname>DateTime::modify</methodname>
<methodparam><type>string</type><parameter>modify</parameter></methodparam>
</methodsynopsis>

View file

@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<methodsynopsis role="oop">
<modifier>public</modifier> <modifier>static</modifier> <type>DateTime</type><methodname>DateTime::__set_state</methodname>
<methodparam><type>array</type><parameter>array</parameter></methodparam>
</methodsynopsis>

View file

@ -10,7 +10,7 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis>
<methodsynopsis role="oop">
<modifier>public</modifier> <type>DateTime</type><methodname>DateTime::setDate</methodname>
<methodparam><type>int</type><parameter>year</parameter></methodparam>
<methodparam><type>int</type><parameter>month</parameter></methodparam>

View file

@ -10,7 +10,7 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis>
<methodsynopsis role="oop">
<modifier>public</modifier> <type>DateTime</type><methodname>DateTime::setISODate</methodname>
<methodparam><type>int</type><parameter>year</parameter></methodparam>
<methodparam><type>int</type><parameter>week</parameter></methodparam>

View file

@ -10,7 +10,7 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis>
<methodsynopsis role="oop">
<modifier>public</modifier> <type>DateTime</type><methodname>DateTime::setTime</methodname>
<methodparam><type>int</type><parameter>hour</parameter></methodparam>
<methodparam><type>int</type><parameter>minute</parameter></methodparam>

View file

@ -10,7 +10,7 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis>
<methodsynopsis role="oop">
<modifier>public</modifier> <type>DateTime</type><methodname>DateTime::setTimestamp</methodname>
<methodparam><type>int</type><parameter>unixtimestamp</parameter></methodparam>
</methodsynopsis>

View file

@ -10,7 +10,7 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis>
<methodsynopsis role="oop">
<modifier>public</modifier> <type>DateTime</type><methodname>DateTime::setTimezone</methodname>
<methodparam><type>DateTimeZone</type><parameter>timezone</parameter></methodparam>
</methodsynopsis>

View file

@ -13,7 +13,7 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis>
<methodsynopsis role="oop">
<modifier>public</modifier> <type>DateTime</type><methodname>DateTime::sub</methodname>
<methodparam><type>DateInterval</type><parameter>interval</parameter></methodparam>
</methodsynopsis>

View file

@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<methodsynopsis role="oop">
<modifier>public</modifier> <type>DateTime</type><methodname>DateTime::__wakeup</methodname>
<void />
</methodsynopsis>

View file

@ -118,7 +118,8 @@
</fieldsynopsis>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.datetimezone')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.datetimezone')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis)" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.datetimezone')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='oop'])" />
</classsynopsis>
<!-- }}} -->

View file

@ -10,12 +10,12 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis>
<constructorsynopsis>
<modifier>public</modifier> <methodname>DateTimeZone::__construct</methodname>
<methodparam><type>string</type><parameter>timezone</parameter></methodparam>
</methodsynopsis>
</constructorsynopsis>
<para>&style.procedural;</para>
<methodsynopsis>
<methodsynopsis role="procedural">
<type>DateTimeZone</type><methodname>timezone_open</methodname>
<methodparam><type>string</type><parameter>timezone</parameter></methodparam>
</methodsynopsis>

View file

@ -9,10 +9,16 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<para>&style.oop;</para>
<methodsynopsis role="oop">
<modifier>public</modifier> <type>array</type><methodname>DateTimeZone::getLocation</methodname>
<void />
</methodsynopsis>
<para>&style.procedural;</para>
<methodsynopsis role="procedural">
<type>array</type><methodname>timezone_location_get</methodname>
<void />
</methodsynopsis>
<para>
Returns location information for a timezone, including country code, latitude/longitude and comments.
</para>

View file

@ -9,10 +9,16 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<para>&style.oop;</para>
<methodsynopsis role="oop">
<modifier>public</modifier> <type>string</type><methodname>DateTimeZone::getName</methodname>
<void />
</methodsynopsis>
<para>&style.procedural;</para>
<methodsynopsis role="procedural">
<type>string</type><methodname>timezone_name_get</methodname>
<void />
</methodsynopsis>
<para>
Returns the name of the timezone.
</para>

View file

@ -8,11 +8,13 @@
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<para>&style.oop;</para>
<methodsynopsis role="oop">
<modifier>public</modifier> <type>int</type><methodname>DateTimeZone::getOffset</methodname>
<methodparam><type>DateTime</type><parameter>datetime</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<para>&style.procedural;</para>
<methodsynopsis role="procedural">
<type>int</type><methodname>timezone_offset_get</methodname>
<methodparam><type>DateTimeZone</type><parameter>object</parameter></methodparam>
<methodparam><type>DateTime</type><parameter>datetime</parameter></methodparam>

View file

@ -8,12 +8,14 @@
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<para>&style.oop;</para>
<methodsynopsis role="oop">
<modifier>public</modifier> <type>array</type><methodname>DateTimeZone::getTransitions</methodname>
<methodparam choice="opt"><type>int</type><parameter>timestamp_begin</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>timestamp_end</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<para>&style.procedural;</para>
<methodsynopsis role="procedural">
<type>array</type><methodname>timezone_transitions_get</methodname>
<methodparam><type>DateTimeZone</type><parameter>object</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>timestamp_begin</parameter></methodparam>

View file

@ -8,11 +8,13 @@
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<para>&style.oop;</para>
<methodsynopsis role="oop">
<modifier>public</modifier> <modifier>static</modifier> <type>array</type><methodname>DateTimeZone::listAbbreviations</methodname>
<void/>
</methodsynopsis>
<methodsynopsis>
<para>&style.procedural;</para>
<methodsynopsis role="procedural">
<type>array</type><methodname>timezone_abbreviations_list</methodname>
<void/>
</methodsynopsis>

View file

@ -8,12 +8,14 @@
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<para>&style.oop;</para>
<methodsynopsis role="oop">
<modifier>public</modifier> <modifier>static</modifier> <type>array</type><methodname>DateTimeZone::listIdentifiers</methodname>
<methodparam choice="opt"><type>int</type><parameter>what</parameter><initializer>DateTimeZone::ALL</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>country</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<methodsynopsis>
<para>&style.procedural;</para>
<methodsynopsis role="procedural">
<type>array</type><methodname>timezone_identifiers_list</methodname>
<methodparam choice="opt"><type>int</type><parameter>what</parameter><initializer>DateTimeZone::ALL</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>country</parameter><initializer>&null;</initializer></methodparam>