reference/intl/intlcalendar/setminimaldaysinfirstweek.xml
bad9acb50797346b072f9ff6addf05ee6c385570
bad9acb50797346b072f9ff6addf05ee6c385570
...
...
@@ -1,6 +1,5 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-
4
3
<refentry xml:id="intlcalendar.setminimaldaysinfirstweek" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
5
4
<refnamediv>
6
5
<refname>IntlCalendar::setMinimalDaysInFirstWeek</refname>
...
...
@@ -12,17 +11,17 @@
12
11
<para>
13
12
&style.oop;
14
13
</para>
15
-
<methodsynopsis>
16
-
<modifier>public</modifier> <type>bool</type><methodname>IntlCalendar::setMinimalDaysInFirstWeek</methodname>
17
-
<methodparam><type>int</type><parameter>minimalDays</parameter></methodparam>
14
+
<methodsynopsis role="IntlCalendar">
15
+
<modifier>public</modifier> <type>true</type><methodname>IntlCalendar::setMinimalDaysInFirstWeek</methodname>
16
+
<methodparam><type>int</type><parameter>days</parameter></methodparam>
18
17
</methodsynopsis>
19
18
<para>
20
19
&style.procedural;
21
20
</para>
22
21
<methodsynopsis>
23
-
<type>bool</type><methodname>intlcal_get_minimal_days_in_first_week</methodname>
24
-
<methodparam><type>IntlCalendar</type><parameter>cal</parameter></methodparam>
25
-
<methodparam><type>int</type><parameter>minimalDays</parameter></methodparam>
22
+
<type>true</type><methodname>intlcal_set_minimal_days_in_first_week</methodname>
23
+
<methodparam><type>IntlCalendar</type><parameter>calendar</parameter></methodparam>
24
+
<methodparam><type>int</type><parameter>days</parameter></methodparam>
26
25
</methodsynopsis>
27
26
<para>
28
27
Sets the smallest number of days the first week of a year or month must
...
...
@@ -40,15 +39,13 @@
40
39
&reftitle.parameters;
41
40
<variablelist>
42
41
<varlistentry>
43
-
<term><parameter>cal</parameter></term>
42
+
<term><parameter>calendar</parameter></term>
44
43
<listitem>
45
-
<para>
46
-
The IntlCalendar resource.
47
-
</para>
44
+
&intl.parameter.intl-calendar;
48
45
</listitem>
49
46
</varlistentry>
50
47
<varlistentry>
51
-
<term><parameter>minimalDays</parameter></term>
48
+
<term><parameter>days</parameter></term>
52
49
<listitem>
53
50
<para>
54
51
The number of minimal days to set.
...
...
@@ -61,12 +58,43 @@
61
58
<refsect1 role="returnvalues">
62
59
&reftitle.returnvalues;
63
60
<para>
64
-
&true; on success, &false; on failure.
61
+
&return.true.always;
65
62
</para>
66
63
</refsect1>
67
64
68
-
</refentry>
65
+
<refsect1 role="errors">
66
+
&reftitle.errors;
67
+
<para>
68
+
<classname>ValueError</classname> if <parameter>days</parameter> is out of range
69
+
(less than <literal>1</literal> or more than <literal>7</literal>).
70
+
</para>
71
+
</refsect1>
72
+
73
+
<refsect1 role="changelog">
74
+
&reftitle.changelog;
75
+
<para>
76
+
<informaltable>
77
+
<tgroup cols="2">
78
+
<thead>
79
+
<row>
80
+
<entry>&Version;</entry>
81
+
<entry>&Description;</entry>
82
+
</row>
83
+
</thead>
84
+
<tbody>
85
+
<row>
86
+
<entry>8.0.0</entry>
87
+
<entry>
88
+
A <classname>ValueError</classname> is now thrown on invalid input. Previously, &false; was returned.
89
+
</entry>
90
+
</row>
91
+
</tbody>
92
+
</tgroup>
93
+
</informaltable>
94
+
</para>
95
+
</refsect1>
69
96
97
+
</refentry>
70
98
<!-- Keep this comment at the end of the file
71
99
Local variables:
72
100
mode: sgml
73
101