Skip to content

Commit 4f8ae13

Browse files
committed
intl: document the procedural style of IntlGregorianCalendar methods
1 parent a645095 commit 4f8ae13

3 files changed

Lines changed: 60 additions & 26 deletions

File tree

reference/intl/intlgregoriancalendar/getgregorianchange.xml

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,21 +8,33 @@
88

99
<refsect1 role="description">
1010
&reftitle.description;
11+
<simpara>&style.oop;</simpara>
1112
<methodsynopsis role="IntlGregorianCalendar">
1213
<modifier>public</modifier> <type>float</type><methodname>IntlGregorianCalendar::getGregorianChange</methodname>
1314
<void/>
1415
</methodsynopsis>
15-
<para>
16-
17-
</para>
18-
19-
&warn.undocumented.func;
20-
16+
<simpara>&style.procedural;</simpara>
17+
<methodsynopsis>
18+
<type>float</type><methodname>intlgregcal_get_gregorian_change</methodname>
19+
<methodparam><type>IntlGregorianCalendar</type><parameter>calendar</parameter></methodparam>
20+
</methodsynopsis>
21+
<simpara>
22+
Gets the Gregorian Calendar change date. This is the point at which the
23+
calendar switches from Julian dates to Gregorian dates, expressed as a UNIX
24+
timestamp in milliseconds. It defaults to midnight (UTC) on October 15, 1582.
25+
</simpara>
2126
</refsect1>
2227

2328
<refsect1 role="parameters">
2429
&reftitle.parameters;
25-
&no.function.parameters;
30+
<variablelist>
31+
<varlistentry>
32+
<term><parameter>calendar</parameter></term>
33+
<listitem>
34+
<simpara>An <classname>IntlGregorianCalendar</classname> instance.</simpara>
35+
</listitem>
36+
</varlistentry>
37+
</variablelist>
2638
</refsect1>
2739

2840
<refsect1 role="returnvalues">

reference/intl/intlgregoriancalendar/isleapyear.xml

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,27 +8,36 @@
88

99
<refsect1 role="description">
1010
&reftitle.description;
11+
<simpara>&style.oop;</simpara>
1112
<methodsynopsis role="IntlGregorianCalendar">
1213
<modifier>public</modifier> <type>bool</type><methodname>IntlGregorianCalendar::isLeapYear</methodname>
1314
<methodparam><type>int</type><parameter>year</parameter></methodparam>
1415
</methodsynopsis>
15-
<para>
16-
17-
</para>
18-
19-
&warn.undocumented.func;
20-
16+
<simpara>&style.procedural;</simpara>
17+
<methodsynopsis>
18+
<type>bool</type><methodname>intlgregcal_is_leap_year</methodname>
19+
<methodparam><type>IntlGregorianCalendar</type><parameter>calendar</parameter></methodparam>
20+
<methodparam><type>int</type><parameter>year</parameter></methodparam>
21+
</methodsynopsis>
22+
<simpara>
23+
Determines whether the given <parameter>year</parameter> is a leap year
24+
in the Gregorian calendar.
25+
</simpara>
2126
</refsect1>
2227

2328
<refsect1 role="parameters">
2429
&reftitle.parameters;
2530
<variablelist>
31+
<varlistentry>
32+
<term><parameter>calendar</parameter></term>
33+
<listitem>
34+
<simpara>An <classname>IntlGregorianCalendar</classname> instance.</simpara>
35+
</listitem>
36+
</varlistentry>
2637
<varlistentry>
2738
<term><parameter>year</parameter></term>
2839
<listitem>
29-
<para>
30-
31-
</para>
40+
<simpara>The year to check.</simpara>
3241
</listitem>
3342
</varlistentry>
3443
</variablelist>

reference/intl/intlgregoriancalendar/setgregorianchange.xml

Lines changed: 23 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,32 +3,45 @@
33
<refentry xml:id="intlgregoriancalendar.setgregorianchange" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
44
<refnamediv>
55
<refname>IntlGregorianCalendar::setGregorianChange</refname>
6-
<refpurpose>Set the Gregorian Calendar the change date</refpurpose>
6+
<refpurpose>Set the Gregorian Calendar change date</refpurpose>
77
</refnamediv>
88

99
<refsect1 role="description">
1010
&reftitle.description;
11+
<simpara>&style.oop;</simpara>
1112
<methodsynopsis role="IntlGregorianCalendar">
1213
<modifier>public</modifier> <type>bool</type><methodname>IntlGregorianCalendar::setGregorianChange</methodname>
1314
<methodparam><type>float</type><parameter>timestamp</parameter></methodparam>
1415
</methodsynopsis>
15-
<para>
16-
17-
</para>
18-
19-
&warn.undocumented.func;
20-
16+
<simpara>&style.procedural;</simpara>
17+
<methodsynopsis>
18+
<type>bool</type><methodname>intlgregcal_set_gregorian_change</methodname>
19+
<methodparam><type>IntlGregorianCalendar</type><parameter>calendar</parameter></methodparam>
20+
<methodparam><type>float</type><parameter>timestamp</parameter></methodparam>
21+
</methodsynopsis>
22+
<simpara>
23+
Sets the Gregorian Calendar change date. This is the point at which the
24+
calendar switches from Julian dates to Gregorian dates, expressed as a UNIX
25+
timestamp in milliseconds.
26+
</simpara>
2127
</refsect1>
2228

2329
<refsect1 role="parameters">
2430
&reftitle.parameters;
2531
<variablelist>
32+
<varlistentry>
33+
<term><parameter>calendar</parameter></term>
34+
<listitem>
35+
<simpara>An <classname>IntlGregorianCalendar</classname> instance.</simpara>
36+
</listitem>
37+
</varlistentry>
2638
<varlistentry>
2739
<term><parameter>timestamp</parameter></term>
2840
<listitem>
29-
<para>
30-
31-
</para>
41+
<simpara>
42+
The Gregorian Calendar change date, expressed as a UNIX timestamp in
43+
milliseconds.
44+
</simpara>
3245
</listitem>
3346
</varlistentry>
3447
</variablelist>

0 commit comments

Comments
 (0)