r

Use Erlang specs and types for documentation

1 files changed, 14 insertions, 32 deletions

diff --git a/lib/stdlib/doc/src/pool.xml b/lib/stdlib/doc/src/pool.xml
index 2b890352eb..39a79e5dc5 100644
--- a/lib/stdlib/doc/src/pool.xml
+++ b/lib/stdlib/doc/src/pool.xml
@@ -4,7 +4,7 @@
 <erlref>
   <header>
     <copyright>
-      <year>1996</year><year>2009</year>
+      <year>1996</year><year>2011</year>
       <holder>Ericsson AB. All Rights Reserved.</holder>
     </copyright>
     <legalnotice>
@@ -48,23 +48,19 @@
   </description>
   <funcs>
     <func>
-      <name>start(Name) -></name>
-      <name>start(Name, Args) -> Nodes</name>
+      <name name="start" arity="1"/>
+      <name name="start" arity="2"/>
       <fsummary>>Start a new pool</fsummary>
-      <type>
-        <v>Name = atom()</v>
-        <v>Args = string()</v>
-        <v>Nodes = [node()]</v>
-      </type>
       <desc>
         <p>Starts a new pool. The file <c>.hosts.erlang</c> is read to
           find host names where the pool nodes can be started. See
           section <seealso marker="#files">Files</seealso> below. The
           start-up procedure fails if the file is not found.</p>
         <p>The slave nodes are started with <c>slave:start/2,3</c>,
-          passing along <c>Name</c> and, if provided, <c>Args</c>.
-          <c>Name</c> is used as the first part of the node names,
-          <c>Args</c> is used to specify command line arguments. See
+          passing along <c><anno>Name</anno></c> and, if provided,
+          <c><anno>Args</anno></c>.
+          <c><anno>Name</anno></c> is used as the first part of the node names,
+          <c><anno>Args</anno></c> is used to specify command line arguments. See
           <seealso marker="slave#start/2">slave(3)</seealso>.</p>
         <p>Access rights must be set so that all nodes in the pool have
           the authority to access each other.</p>
@@ -73,59 +69,45 @@
       </desc>
     </func>
     <func>
-      <name>attach(Node) -> already_attached | attached</name>
+      <name name="attach" arity="1"/>
       <fsummary>Ensure that a pool master is running</fsummary>
-      <type>
-        <v>Node = node()</v>
-      </type>
       <desc>
         <p>This function ensures that a pool master is running and
-          includes <c>Node</c> in the pool master's pool of nodes.</p>
+          includes <c><anno>Node</anno></c> in the pool master's pool of nodes.</p>
       </desc>
     </func>
     <func>
-      <name>stop() -> stopped</name>
+      <name name="stop" arity="0"/>
       <fsummary>Stop the pool and kill all the slave nodes</fsummary>
       <desc>
         <p>Stops the pool and kills all the slave nodes.</p>
       </desc>
     </func>
     <func>
-      <name>get_nodes() -> Nodes</name>
+      <name name="get_nodes" arity="0"/>
       <fsummary>Return a list of the current member nodes of the pool</fsummary>
-      <type>
-        <v>Nodes = [node()]</v>
-      </type>
       <desc>
         <p>Returns a list of the current member nodes of the pool.</p>
       </desc>
     </func>
     <func>
-      <name>pspawn(Mod, Fun, Args) -> pid()</name>
+      <name name="pspawn" arity="3"/>
       <fsummary>Spawn a process on the pool node with expected lowest future load</fsummary>
-      <type>
-        <v>Mod = Fun = atom()</v>
-        <v>Args = [term()]</v>
-      </type>
       <desc>
         <p>Spawns a process on the pool node which is expected to have
           the lowest future load.</p>
       </desc>
     </func>
     <func>
-      <name>pspawn_link(Mod, Fun, Args) -> pid()</name>
+      <name name="pspawn_link" arity="3"/>
       <fsummary>Spawn and link to a process on the pool node with expected lowest future load</fsummary>
-      <type>
-        <v>Mod = Fun = atom()</v>
-        <v>Args = [term()]</v>
-      </type>
       <desc>
         <p>Spawn links a process on the pool node which is expected to
           have the lowest future load.</p>
       </desc>
     </func>
     <func>
-      <name>get_node() -> node()</name>
+      <name name="get_node" arity="0"/>
       <fsummary>Return the node with the expected lowest future load</fsummary>
       <desc>
         <p>Returns the node with the expected lowest future load.</p>