-
Notifications
You must be signed in to change notification settings - Fork 860
Expand file tree
/
Copy pathconstruct.xml
More file actions
58 lines (53 loc) · 1.58 KB
/
construct.xml
File metadata and controls
58 lines (53 loc) · 1.58 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
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="parallel-sync.construct">
<refnamediv>
<refname>parallel\Sync::__construct</refname>
<refpurpose>Construction</refpurpose>
</refnamediv>
<refsect1 role="description" audience="construction">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <methodname>parallel\Sync::__construct</methodname>
<void/>
</methodsynopsis>
<simpara>
Shall construct a new synchronization object with no value
</simpara>
<methodsynopsis>
<modifier>public</modifier> <methodname>parallel\Sync::__construct</methodname>
<methodparam><type>scalar</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<simpara>
Shall construct a new synchronization object containing the given scalar value
</simpara>
</refsect1>
<refsect1 role="exceptions">
<title>Exceptions</title>
<warning>
<simpara>
Shall throw <type>parallel\Sync\Error\IllegalValue</type> if <parameter>value</parameter> is non-scalar.
</simpara>
</warning>
</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
-->