reference/intl/messageformatter/create.xml
1976eae0d815797af97a1e16c5cd90ffc2868395
...
...
@@ -1,6 +1,6 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="messageformatter.create">
3
+
<refentry xml:id="messageformatter.create" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
4
4
<refnamediv>
5
5
<refname>MessageFormatter::create</refname>
6
6
<refname>MessageFormatter::__construct</refname>
...
...
@@ -13,20 +13,16 @@
13
13
<para>
14
14
&style.oop; (method)
15
15
</para>
16
-
<methodsynopsis>
17
-
<modifier>public</modifier>
18
-
<modifier>static</modifier>
19
-
<type>MessageFormatter</type>
20
-
<methodname>MessageFormatter::create</methodname>
16
+
<methodsynopsis role="MessageFormatter">
17
+
<modifier>public</modifier> <modifier>static</modifier> <type class="union"><type>MessageFormatter</type><type>null</type></type><methodname>MessageFormatter::create</methodname>
21
18
<methodparam><type>string</type><parameter>locale</parameter></methodparam>
22
19
<methodparam><type>string</type><parameter>pattern</parameter></methodparam>
23
20
</methodsynopsis>
24
21
<para>
25
22
&style.oop; (constructor):
26
23
</para>
27
-
<constructorsynopsis>
28
-
<modifier>public</modifier>
29
-
<methodname>MessageFormatter::__construct</methodname>
24
+
<constructorsynopsis role="MessageFormatter">
25
+
<modifier>public</modifier> <methodname>MessageFormatter::__construct</methodname>
30
26
<methodparam><type>string</type><parameter>locale</parameter></methodparam>
31
27
<methodparam><type>string</type><parameter>pattern</parameter></methodparam>
32
28
</constructorsynopsis>
...
...
@@ -34,8 +30,7 @@
34
30
&style.procedural;
35
31
</para>
36
32
<methodsynopsis>
37
-
<type>MessageFormatter</type>
38
-
<methodname>msgfmt_create</methodname>
33
+
<type class="union"><type>MessageFormatter</type><type>null</type></type><methodname>msgfmt_create</methodname>
39
34
<methodparam><type>string</type><parameter>locale</parameter></methodparam>
40
35
<methodparam><type>string</type><parameter>pattern</parameter></methodparam>
41
36
</methodsynopsis>
...
...
@@ -61,10 +56,8 @@
61
56
<listitem>
62
57
<para>
63
58
The pattern string to stick arguments into.
64
-
The pattern uses an 'apostrophe-friendly' syntax; it is run through
65
-
<link
66
-
xlink:href="&url.icu.autoQuoteApostrophe;">umsg_autoQuoteApostrophe</link>
67
-
before being interpreted.
59
+
The pattern uses an 'apostrophe-friendly' syntax;
60
+
see <link xlink:href="&url.icu.quoting;">Quoting/Escaping</link> for details.
68
61
</para>
69
62
</listitem>
70
63
</varlistentry>
...
...
@@ -76,7 +69,15 @@
76
69
<refsect1 role="returnvalues">
77
70
&reftitle.returnvalues;
78
71
<para>
79
-
The formatter <type>object</type>
72
+
The formatter <type>object</type>, or &null; on failure.
73
+
</para>
74
+
</refsect1>
75
+

76
+
<refsect1 role="errors">
77
+
&reftitle.errors;
78
+
<para>
79
+
When invoked as constructor, on failure an <classname>IntlException</classname>
80
+
is thrown.
80
81
</para>
81
82
</refsect1>
82
83

83
84