Skip to content

Commit 322606e

Browse files
author
Baokun Dou
committed
Update swoole docs
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@344519 c90b9560-bf6c-de11-be94-00142212c4b1
1 parent 0d15d96 commit 322606e

File tree

313 files changed

+19247
-128
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

313 files changed

+19247
-128
lines changed

‎reference/swoole/book.xml‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,37 @@
2424
&reference.swoole.constants;
2525
&reference.swoole.reference;
2626

27+
&reference.swoole.swoole.async;
28+
&reference.swoole.swoole.atomic;
29+
&reference.swoole.swoole.buffer;
30+
&reference.swoole.swoole.channel;
31+
&reference.swoole.swoole.client;
32+
&reference.swoole.swoole.connection.iterator;
33+
&reference.swoole.swoole.coroutine;
34+
<!-- &reference.swoole.swoole.coroutine.client; -->
35+
<!-- &reference.swoole.swoole.coroutine.http.client; -->
36+
<!-- &reference.swoole.swoole.coroutine.mysql; -->
37+
<!-- &reference.swoole.swoole.coroutine.mysql.exception; -->
38+
&reference.swoole.swoole.event;
39+
&reference.swoole.swoole.exception;
40+
&reference.swoole.swoole.http.client;
41+
&reference.swoole.swoole.http.request;
42+
&reference.swoole.swoole.http.response;
43+
&reference.swoole.swoole.http.server;
44+
&reference.swoole.swoole.lock;
45+
&reference.swoole.swoole.mmap;
46+
&reference.swoole.swoole.mysql;
47+
&reference.swoole.swoole.mysql.exception;
48+
&reference.swoole.swoole.process;
49+
&reference.swoole.swoole.redis.server;
50+
&reference.swoole.swoole.serialize;
51+
&reference.swoole.swoole.server;
52+
<!-- &reference.swoole.swoole.server.port; -->
53+
&reference.swoole.swoole.table;
54+
&reference.swoole.swoole.timer;
55+
&reference.swoole.swoole.websocket.frame;
56+
&reference.swoole.swoole.websocket.server;
57+
2758
</book>
2859

2960
<!-- Keep this comment at the end of the file

‎reference/swoole/entities.functions.xml‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
&reference.swoole.functions.swoole-async-dns-lookup;
2+
&reference.swoole.functions.swoole-async-read;
3+
&reference.swoole.functions.swoole-async-readfile;
4+
&reference.swoole.functions.swoole-async-set;
5+
&reference.swoole.functions.swoole-async-write;
6+
&reference.swoole.functions.swoole-async-writefile;
7+
&reference.swoole.functions.swoole-client-select;
8+
&reference.swoole.functions.swoole-cpu-num;
9+
&reference.swoole.functions.swoole-errno;
10+
&reference.swoole.functions.swoole-event-add;
11+
&reference.swoole.functions.swoole-event-defer;
12+
&reference.swoole.functions.swoole-event-del;
13+
&reference.swoole.functions.swoole-event-exit;
14+
&reference.swoole.functions.swoole-event-set;
15+
&reference.swoole.functions.swoole-event-wait;
16+
&reference.swoole.functions.swoole-event-write;
17+
&reference.swoole.functions.swoole-get-local-ip;
18+
&reference.swoole.functions.swoole-last-error;
19+
&reference.swoole.functions.swoole-load-module;
20+
&reference.swoole.functions.swoole-select;
21+
&reference.swoole.functions.swoole-set-process-name;
22+
&reference.swoole.functions.swoole-strerror;
23+
&reference.swoole.functions.swoole-timer-after;
24+
&reference.swoole.functions.swoole-timer-exists;
25+
&reference.swoole.functions.swoole-timer-tick;
26+
&reference.swoole.functions.swoole-version;

‎reference/swoole/entities.swoole.xml‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
&reference.swoole.swoole.entities.async;
2+
&reference.swoole.swoole.entities.atomic;
3+
&reference.swoole.swoole.entities.buffer;
4+
&reference.swoole.swoole.entities.channel;
5+
&reference.swoole.swoole.entities.client;
6+
&reference.swoole.swoole.entities.connection;
7+
&reference.swoole.swoole.entities.coroutine;
8+
&reference.swoole.swoole.entities.event;
9+
&reference.swoole.swoole.entities.http;
10+
&reference.swoole.swoole.entities.lock;
11+
&reference.swoole.swoole.entities.mmap;
12+
&reference.swoole.swoole.entities.mysql;
13+
&reference.swoole.swoole.entities.process;
14+
&reference.swoole.swoole.entities.redis;
15+
&reference.swoole.swoole.entities.serialize;
16+
&reference.swoole.swoole.entities.server;
17+
&reference.swoole.swoole.entities.table;
18+
&reference.swoole.swoole.entities.timer;
19+
&reference.swoole.swoole.entities.websocket;

‎reference/swoole/functions/swoole-async-read.xml‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
<term><parameter>filename</parameter></term>
3030
<listitem>
3131
<para>
32-
The filename being read.
32+
The filename of the file being read.
3333
</para>
3434
</listitem>
3535
</varlistentry>
@@ -83,11 +83,10 @@
8383
<refsect1 role="returnvalues">
8484
&reftitle.returnvalues;
8585
<para>
86-
Whether the read if succeed.
86+
Whether the read is succeed.
8787
</para>
8888
</refsect1>
8989

90-
9190
</refentry>
9291

9392
<!-- Keep this comment at the end of the file

‎reference/swoole/functions/swoole-async-readfile.xml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
<methodsynopsis>
1313
<type>bool</type><methodname>swoole_async_readfile</methodname>
1414
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
15-
<methodparam><type>string</type><parameter>callback</parameter></methodparam>
15+
<methodparam><type>callable</type><parameter>callback</parameter></methodparam>
1616
</methodsynopsis>
1717
<para>
1818

@@ -27,7 +27,7 @@
2727
<term><parameter>filename</parameter></term>
2828
<listitem>
2929
<para>
30-
The filename being read.
30+
The filename of the file being read.
3131
</para>
3232
</listitem>
3333
</varlistentry>

‎reference/swoole/functions/swoole-async-set.xml‎

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
<methodparam><type>array</type><parameter>settings</parameter></methodparam>
1515
</methodsynopsis>
1616
<para>
17-
17+
1818
</para>
1919

2020
</refsect1>
@@ -33,14 +33,6 @@
3333
</variablelist>
3434
</refsect1>
3535

36-
<refsect1 role="returnvalues">
37-
&reftitle.returnvalues;
38-
<para>
39-
40-
</para>
41-
</refsect1>
42-
43-
4436
</refentry>
4537

4638
<!-- Keep this comment at the end of the file

‎reference/swoole/functions/swoole-async-write.xml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
<type>bool</type><methodname>swoole_async_write</methodname>
1414
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
1515
<methodparam><type>string</type><parameter>content</parameter></methodparam>
16-
<methodparam choice="opt"><type>int</type><parameter>offset</parameter><initializer>-1</initializer></methodparam>
16+
<methodparam choice="opt"><type>integer</type><parameter>offset</parameter></methodparam>
1717
<methodparam choice="opt"><type>callable</type><parameter>callback</parameter></methodparam>
1818
</methodsynopsis>
1919
<para>
@@ -29,23 +29,23 @@
2929
<term><parameter>filename</parameter></term>
3030
<listitem>
3131
<para>
32-
32+
The filename being written.
3333
</para>
3434
</listitem>
3535
</varlistentry>
3636
<varlistentry>
3737
<term><parameter>content</parameter></term>
3838
<listitem>
3939
<para>
40-
40+
The content writing to the file.
4141
</para>
4242
</listitem>
4343
</varlistentry>
4444
<varlistentry>
4545
<term><parameter>offset</parameter></term>
4646
<listitem>
4747
<para>
48-
48+
The offset.
4949
</para>
5050
</listitem>
5151
</varlistentry>

‎reference/swoole/functions/swoole-async-writefile.xml‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,13 @@
1313
<type>bool</type><methodname>swoole_async_writefile</methodname>
1414
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
1515
<methodparam><type>string</type><parameter>content</parameter></methodparam>
16-
<methodparam choice="opt"><type>string</type><parameter>callback</parameter></methodparam>
16+
<methodparam choice="opt"><type>callable</type><parameter>callback</parameter></methodparam>
1717
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
1818
</methodsynopsis>
1919
<para>
2020

2121
</para>
2222

23-
&warn.undocumented.func;
24-
2523
</refsect1>
2624

2725
<refsect1 role="parameters">
@@ -31,15 +29,15 @@
3129
<term><parameter>filename</parameter></term>
3230
<listitem>
3331
<para>
34-
32+
The filename being written.
3533
</para>
3634
</listitem>
3735
</varlistentry>
3836
<varlistentry>
3937
<term><parameter>content</parameter></term>
4038
<listitem>
4139
<para>
42-
40+
The content writing to the file.
4341
</para>
4442
</listitem>
4543
</varlistentry>

‎reference/swoole/reference.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<?xml version="1.0" encoding="utf-8"?>
22
<!-- $Revision$ -->
33

4-
<reference xml:id="ref.swoole" xmlns="http://docbook.org/ns/docbook">
4+
<reference xml:id="ref.swoole-funcs" xmlns="http://docbook.org/ns/docbook">
55
<title>Swoole &Functions;</title>
66

77
&reference.swoole.entities.functions;

‎reference/swoole/swoole.async.xml‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<!-- $Revision$ -->
3+
4+
<phpdoc:classref xml:id="class.swoole-async" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
5+
6+
<title>The Swoole\Async class</title>
7+
<titleabbrev>Swoole\Async</titleabbrev>
8+
9+
<partintro>
10+
11+
<!-- {{{ Swoole\Async intro -->
12+
<section xml:id="swoole-async.intro">
13+
&reftitle.intro;
14+
<para>
15+
16+
</para>
17+
</section>
18+
<!-- }}} -->
19+
20+
<section xml:id="swoole-async.synopsis">
21+
&reftitle.classsynopsis;
22+
23+
<!-- {{{ Synopsis -->
24+
<classsynopsis>
25+
<ooclass><classname>Swoole\Async</classname></ooclass>
26+
27+
<!-- {{{ Class synopsis -->
28+
<classsynopsisinfo>
29+
<ooclass>
30+
<classname>Swoole\Async</classname>
31+
</ooclass>
32+
</classsynopsisinfo>
33+
<!-- }}} -->
34+
35+
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
36+
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.swoole-async')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
37+
</classsynopsis>
38+
<!-- }}} -->
39+
40+
</section>
41+
42+
</partintro>
43+
44+
&reference.swoole.swoole.entities.async;
45+
46+
</phpdoc:classref>
47+
48+
<!-- Keep this comment at the end of the file
49+
Local variables:
50+
mode: sgml
51+
sgml-omittag:t
52+
sgml-shorttag:t
53+
sgml-minimize-attributes:nil
54+
sgml-always-quote-attributes:t
55+
sgml-indent-step:1
56+
sgml-indent-data:t
57+
indent-tabs-mode:nil
58+
sgml-parent-document:nil
59+
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
60+
sgml-exposed-tags:nil
61+
sgml-local-catalogs:nil
62+
sgml-local-ecat-files:nil
63+
End:
64+
vim600: syn=xml fen fdm=syntax fdl=2 si
65+
vim: et tw=78 syn=sgml
66+
vi: ts=1 sw=1
67+
-->

0 commit comments

Comments
 (0)