aboutsummaryrefslogtreecommitdiffstats
path: root/lib/stdlib/doc/src/pg.xml
diff options
context:
space:
mode:
authorHans Bolinder <[email protected]>2011-05-13 14:08:25 +0200
committerHans Bolinder <[email protected]>2011-05-13 14:08:59 +0200
commit0ccc57b1e3772deaf5650077808a38a52b1133b9 (patch)
treeed98a14e3cda51c344a04c85db7843b274dfe56a /lib/stdlib/doc/src/pg.xml
parent22f3c9720cb7d19a3aafac613f03aede91d6283f (diff)
parent229d0d8ca88bc344bed89e46541b325c1d267996 (diff)
downloadotp-0ccc57b1e3772deaf5650077808a38a52b1133b9.tar.gz
otp-0ccc57b1e3772deaf5650077808a38a52b1133b9.tar.bz2
otp-0ccc57b1e3772deaf5650077808a38a52b1133b9.zip
Merge branch 'hb/stdlib/doc_specs/OTP-9271' into dev
* hb/stdlib/doc_specs/OTP-9271: Use Erlang specs and types for documentation Conflicts: lib/stdlib/doc/src/timer.xml
Diffstat (limited to 'lib/stdlib/doc/src/pg.xml')
-rw-r--r--lib/stdlib/doc/src/pg.xml55
1 files changed, 17 insertions, 38 deletions
diff --git a/lib/stdlib/doc/src/pg.xml b/lib/stdlib/doc/src/pg.xml
index b174d4f7d4..c56db8c6e6 100644
--- a/lib/stdlib/doc/src/pg.xml
+++ b/lib/stdlib/doc/src/pg.xml
@@ -51,77 +51,56 @@
</description>
<funcs>
<func>
- <name>create(PgName) -> ok | {error, Reason}</name>
+ <name name="create" arity="1"/>
<fsummary>Create an empty group</fsummary>
- <type>
- <v>PgName = term()</v>
- <v>Reason = already_created | term()</v>
- </type>
<desc>
- <p>Creates an empty group named <c>PgName</c> on the current
+ <p>Creates an empty group named <c><anno>PgName</anno></c> on the current
node.</p>
</desc>
</func>
<func>
- <name>create(PgName, Node) -> ok | {error, Reason}</name>
+ <name name="create" arity="2"/>
<fsummary>Create an empty group on another node</fsummary>
- <type>
- <v>PgName = term()</v>
- <v>Node = node()</v>
- <v>Reason = already_created | term()</v>
- </type>
<desc>
- <p>Creates an empty group named <c>PgName</c> on the node
- <c>Node</c>.</p>
+ <p>Creates an empty group named <c><anno>PgName</anno></c> on the node
+ <c><anno>Node</anno></c>.</p>
</desc>
</func>
<func>
- <name>join(PgName, Pid) -> Members</name>
+ <name name="join" arity="2"/>
<fsummary>Join a pid to a process group</fsummary>
- <type>
- <v>PgName = term()</v>
- <v>Pid = pid()</v>
- <v>Members = [pid()]</v>
- </type>
<desc>
- <p>Joins the pid <c>Pid</c> to the process group <c>PgName</c>.
+ <p>Joins the pid <c><anno>Pid</anno></c> to the process group
+ <c><anno>PgName</anno></c>.
Returns a list of all old members of the group.</p>
</desc>
</func>
<func>
- <name>send(PgName, Msg) -> void()</name>
+ <name name="send" arity="2"/>
<fsummary>Send a message to all members of a process group</fsummary>
- <type>
- <v>PgName = Msg = term()</v>
- </type>
<desc>
<p>Sends the tuple <c>{pg_message, From, PgName, Msg}</c> to
- all members of the process group <c>PgName</c>.</p>
- <p>Failure: <c>{badarg, {PgName, Msg}}</c> if <c>PgName</c> is
+ all members of the process group <c><anno>PgName</anno></c>.</p>
+ <p>Failure: <c>{badarg, {<anno>PgName</anno>, <anno>Msg</anno>}}</c>
+ if <c><anno>PgName</anno></c> is
not a process group (a globally registered name).</p>
</desc>
</func>
<func>
- <name>esend(PgName, Msg) -> void()</name>
+ <name name="esend" arity="2"/>
<fsummary>Send a message to all members of a process group, except ourselves</fsummary>
- <type>
- <v>PgName = Msg = term()</v>
- </type>
<desc>
<p>Sends the tuple <c>{pg_message, From, PgName, Msg}</c> to
- all members of the process group <c>PgName</c>, except
+ all members of the process group <c><anno>PgName</anno></c>, except
ourselves.</p>
- <p>Failure: <c>{badarg, {PgName, Msg}}</c> if <c>PgName</c> is
+ <p>Failure: <c>{badarg, {<anno>PgName</anno>, <anno>Msg</anno>}}</c>
+ if <c><anno>PgName</anno></c> is
not a process group (a globally registered name).</p>
</desc>
</func>
<func>
- <name>members(PgName) -> Members</name>
+ <name name="members" arity="1"/>
<fsummary>Return a list of all members of a process group</fsummary>
- <type>
- <v>PgName = term()</v>
- <v>Members = [pid()]</v>
- </type>
<desc>
<p>Returns a list of all members of the process group
<c>PgName</c>.</p>