Skip to content

intl: document the procedural style of IntlGregorianCalendar methods #5619

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lacatoire wants to merge 1 commit into
base: master
Choose a base branch
from
+60 −26
Open

intl: document the procedural style of IntlGregorianCalendar methods #5619

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 19 additions & 7 deletions reference/intl/intlgregoriancalendar/getgregorianchange.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,33 @@

<refsect1 role="description">
&reftitle.description;
<simpara>&style.oop;</simpara>
<methodsynopsis role="IntlGregorianCalendar">
<modifier>public</modifier> <type>float</type><methodname>IntlGregorianCalendar::getGregorianChange</methodname>
<void/>
</methodsynopsis>
<para>

</para>

&warn.undocumented.func;

<simpara>&style.procedural;</simpara>
<methodsynopsis>
<type>float</type><methodname>intlgregcal_get_gregorian_change</methodname>
<methodparam><type>IntlGregorianCalendar</type><parameter>calendar</parameter></methodparam>
</methodsynopsis>
<simpara>
Gets the Gregorian Calendar change date. This is the point at which the
calendar switches from Julian dates to Gregorian dates, expressed as a UNIX
timestamp in milliseconds. It defaults to midnight (UTC) on October 15, 1582.
</simpara>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
<variablelist>
<varlistentry>
<term><parameter>calendar</parameter></term>
<listitem>
<simpara>An <classname>IntlGregorianCalendar</classname> instance.</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>

<refsect1 role="returnvalues">
Expand Down
27 changes: 18 additions & 9 deletions reference/intl/intlgregoriancalendar/isleapyear.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,27 +8,36 @@

<refsect1 role="description">
&reftitle.description;
<simpara>&style.oop;</simpara>
<methodsynopsis role="IntlGregorianCalendar">
<modifier>public</modifier> <type>bool</type><methodname>IntlGregorianCalendar::isLeapYear</methodname>
<methodparam><type>int</type><parameter>year</parameter></methodparam>
</methodsynopsis>
<para>

</para>

&warn.undocumented.func;

<simpara>&style.procedural;</simpara>
<methodsynopsis>
<type>bool</type><methodname>intlgregcal_is_leap_year</methodname>
<methodparam><type>IntlGregorianCalendar</type><parameter>calendar</parameter></methodparam>
<methodparam><type>int</type><parameter>year</parameter></methodparam>
</methodsynopsis>
<simpara>
Determines whether the given <parameter>year</parameter> is a leap year
in the Gregorian calendar.
</simpara>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>calendar</parameter></term>
<listitem>
<simpara>An <classname>IntlGregorianCalendar</classname> instance.</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>year</parameter></term>
<listitem>
<para>

</para>
<simpara>The year to check.</simpara>
</listitem>
</varlistentry>
</variablelist>
Expand Down
33 changes: 23 additions & 10 deletions reference/intl/intlgregoriancalendar/setgregorianchange.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,32 +3,45 @@
<refentry xml:id="intlgregoriancalendar.setgregorianchange" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>IntlGregorianCalendar::setGregorianChange</refname>
<refpurpose>Set the Gregorian Calendar the change date</refpurpose>
<refpurpose>Set the Gregorian Calendar change date</refpurpose>
</refnamediv>

<refsect1 role="description">
&reftitle.description;
<simpara>&style.oop;</simpara>
<methodsynopsis role="IntlGregorianCalendar">
<modifier>public</modifier> <type>bool</type><methodname>IntlGregorianCalendar::setGregorianChange</methodname>
<methodparam><type>float</type><parameter>timestamp</parameter></methodparam>
</methodsynopsis>
<para>

</para>

&warn.undocumented.func;

<simpara>&style.procedural;</simpara>
<methodsynopsis>
<type>bool</type><methodname>intlgregcal_set_gregorian_change</methodname>
<methodparam><type>IntlGregorianCalendar</type><parameter>calendar</parameter></methodparam>
<methodparam><type>float</type><parameter>timestamp</parameter></methodparam>
</methodsynopsis>
<simpara>
Sets the Gregorian Calendar change date. This is the point at which the
calendar switches from Julian dates to Gregorian dates, expressed as a UNIX
timestamp in milliseconds.
</simpara>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>calendar</parameter></term>
<listitem>
<simpara>An <classname>IntlGregorianCalendar</classname> instance.</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>timestamp</parameter></term>
<listitem>
<para>

</para>
<simpara>
The Gregorian Calendar change date, expressed as a UNIX timestamp in
milliseconds.
</simpara>
</listitem>
</varlistentry>
</variablelist>
Expand Down