-
Notifications
You must be signed in to change notification settings - Fork 855
Expand file tree
/
Copy pathstartdocument.xml
More file actions
132 lines (127 loc) · 4.15 KB
/
startdocument.xml
File metadata and controls
132 lines (127 loc) · 4.15 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry xml:id="xmlwriter.startdocument" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>XMLWriter::startDocument</refname>
<refname>xmlwriter_start_document</refname>
<refpurpose>Create document tag</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis role="XMLWriter">
<modifier>public</modifier> <type>bool</type><methodname>XMLWriter::startDocument</methodname>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>version</parameter><initializer>"1.0"</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>standalone</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>&style.procedural;</para>
<methodsynopsis>
<type>bool</type><methodname>xmlwriter_start_document</methodname>
<methodparam><type>XMLWriter</type><parameter>writer</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>version</parameter><initializer>"1.0"</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>standalone</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Starts a document.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&xmlwriter.xmlwriter.description;
<varlistentry>
<term><parameter>version</parameter></term>
<listitem>
<para>
The version number of the document as part of the XML declaration.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>encoding</parameter></term>
<listitem>
<para>
The encoding of the document as part of the XML declaration.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>standalone</parameter></term>
<listitem>
<para>
<literal>yes</literal> or <literal>no</literal>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<simpara>
Passing an <parameter>encoding</parameter> containing null bytes will
throw a <exceptionname>ValueError</exceptionname>.
</simpara>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.4.0</entry>
<entry>
Passing an <parameter>encoding</parameter> containing null bytes will
now throw a <exceptionname>ValueError</exceptionname>.
</entry>
</row>
&xmlwriter.changelog.writer-param;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>XMLWriter::endDocument</methodname></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->