reference/xml/functions/xml-set-notation-decl-handler.xml
5a14f904d231d294e2e5b4fb5d2fc4d2fd9eddee
...
...
@@ -9,7 +9,7 @@
9
9
<refsect1 role="description">
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
-
<type>bool</type><methodname>xml_set_notation_decl_handler</methodname>
12
+
<type>true</type><methodname>xml_set_notation_decl_handler</methodname>
13
13
<methodparam><type>XMLParser</type><parameter>parser</parameter></methodparam>
14
14
<methodparam><type>callable</type><parameter>handler</parameter></methodparam>
15
15
</methodsynopsis>
...
...
@@ -35,50 +35,28 @@
35
35
&reftitle.parameters;
36
36
<para>
37
37
<variablelist>
38
-
<varlistentry>
39
-
<term><parameter>parser</parameter></term>
40
-
<listitem>
41
-
<para>
42
-
A reference to the XML parser to set up notation declaration handler function.
43
-
</para>
44
-
</listitem>
45
-
</varlistentry>
38
+
&xml.parser.param;
46
39
<varlistentry>
47
40
<term><parameter>handler</parameter></term>
48
41
<listitem>
42
+
&xml.handler.description;
49
43
<para>
50
-
<parameter>handler</parameter> is a string containing the name of a
51
-
function that must exist when <function>xml_parse</function> is called
52
-
for <parameter>parser</parameter>.
53
-
</para>
54
-
<para>
55
-
The function named by <parameter>handler</parameter> must accept
56
-
five parameters:
44
+
The signature of the handler must be:
57
45
<methodsynopsis>
58
-
<methodname><replaceable>handler</replaceable></methodname>
46
+
<type>void</type><methodname><replaceable>handler</replaceable></methodname>
59
47
<methodparam><type>XMLParser</type><parameter>parser</parameter></methodparam>
60
48
<methodparam><type>string</type><parameter>notation_name</parameter></methodparam>
61
-
<methodparam><type>string</type><parameter>base</parameter></methodparam>
49
+
<methodparam><type class="union"><type>string</type><type>false</type></type><parameter>base</parameter></methodparam>
62
50
<methodparam><type>string</type><parameter>system_id</parameter></methodparam>
63
-
<methodparam><type>string</type><parameter>public_id</parameter></methodparam>
51
+
<methodparam><type class="union"><type>string</type><type>false</type></type><parameter>public_id</parameter></methodparam>
64
52
</methodsynopsis>
65
53
<variablelist>
66
-
<varlistentry>
67
-
<term>
68
-
<parameter>parser</parameter>
69
-
</term>
70
-
<listitem>
71
-
<simpara>
72
-
The first parameter, <replaceable>parser</replaceable>, is a
73
-
reference to the XML parser calling the handler.
74
-
</simpara>
75
-
</listitem>
76
-
</varlistentry>
54
+
&xml.handler.parser.param;
77
55
<varlistentry>
78
56
<term><parameter>notation_name</parameter></term>
79
57
<listitem>
80
58
<simpara>
81
-
This is the notation's <parameter>name</parameter>, as per
59
+
This is the notation's name, as per
82
60
the notation format described above.
83
61
</simpara>
84
62
</listitem>
...
...
@@ -90,8 +68,7 @@
90
68
<listitem>
91
69
<simpara>
92
70
This is the base for resolving the system identifier
93
-
(<parameter>system_id</parameter>) of the notation declaration.
94
-
Currently this parameter will always be set to an empty string.
71
+
(<literal>system_id</literal>) of the notation declaration.
95
72
</simpara>
96
73
</listitem>
97
74
</varlistentry>
...
...
@@ -115,11 +92,6 @@
115
92
</varlistentry>
116
93
</variablelist>
117
94
</para>
118
-
<para>
119
-
If a handler function is set to an empty string, or &false;, the handler
120
-
in question is disabled.
121
-
</para>
122
-
&note.func-callback;
123
95
</listitem>
124
96
</varlistentry>
125
97
</variablelist>
...
...
@@ -129,7 +101,7 @@
129
101
<refsect1 role="returnvalues">
130
102
&reftitle.returnvalues;
131
103
<para>
132
-
&return.success;
104
+
&return.true.always;
133
105
</para>
134
106
</refsect1>
135
107

136
108