From 5a485461a1157fef1bb3ce8426bfd1ad57b5ca52 Mon Sep 17 00:00:00 2001
From: Hans Bolinder <hasse@erlang.org>
Date: Fri, 6 May 2011 16:01:56 +0200
Subject: Use Erlang specs and types for documentation

---
 lib/kernel/doc/src/auth.xml | 51 +++++++++++++++++++--------------------------
 1 file changed, 22 insertions(+), 29 deletions(-)

(limited to 'lib/kernel/doc/src/auth.xml')

diff --git a/lib/kernel/doc/src/auth.xml b/lib/kernel/doc/src/auth.xml
index f53fc8b29a..15d9ef0fe4 100644
--- a/lib/kernel/doc/src/auth.xml
+++ b/lib/kernel/doc/src/auth.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>
@@ -34,29 +34,28 @@
       Cookie system, refer to
       <seealso marker="doc/reference_manual:distributed">Distributed Erlang</seealso> in the Erlang Reference Manual.</p>
   </description>
+  <datatypes>
+    <datatype>
+      <name name="cookie"/>
+    </datatype>
+  </datatypes>
   <funcs>
     <func>
-      <name>is_auth(Node) -> yes | no</name>
+      <name name="is_auth" arity="1"/>
       <fsummary>Status of communication authorization (deprecated)</fsummary>
-      <type>
-        <v>Node = node()</v>
-      </type>
       <desc>
-        <p>Returns <c>yes</c> if communication with <c>Node</c> is
-          authorized. Note that a connection to <c>Node</c> will
-          be established in this case. Returns <c>no</c> if <c>Node</c>
+        <p>Returns <c>yes</c> if communication with <c><anno>Node</anno></c> is
+          authorized. Note that a connection to <c><anno>Node</anno></c> will
+          be established in this case. Returns <c>no</c> if <c><anno>Node</anno></c>
           does not exist or communication is not authorized (it has
           another cookie than <c>auth</c> thinks it has).</p>
-        <p>Use <seealso marker="net_adm#ping/1">net_adm:ping(Node)</seealso>
+        <p>Use <seealso marker="net_adm#ping/1">net_adm:ping(<anno>Node</anno>)</seealso>
           instead.</p>
       </desc>
     </func>
     <func>
-      <name>cookie() -> Cookie</name>
+      <name name="cookie" arity="0"/>
       <fsummary>Magic cookie for local node (deprecated)</fsummary>
-      <type>
-        <v>Cookie = atom()</v>
-      </type>
       <desc>
         <p>Use
           <seealso marker="erts:erlang#erlang:get_cookie/0">erlang:get_cookie()</seealso>
@@ -64,16 +63,14 @@
       </desc>
     </func>
     <func>
-      <name>cookie(TheCookie) -> true</name>
+      <name name="cookie" arity="1"/>
       <fsummary>Set the magic for the local node (deprecated)</fsummary>
-      <type>
-        <v>TheCookie = Cookie | [Cookie]</v>
-        <d>The cookie may also be given as a list with a single atom element</d>
-        <v>&nbsp;Cookie = atom()</v>
-      </type>
+      <type_desc variable="TheCookie">
+        The cookie may also be given as a list with a single atom element.
+      </type_desc>
       <desc>
         <p>Use
-          <seealso marker="erts:erlang#erlang:set_cookie/2">erlang:set_cookie(node(), Cookie)</seealso>
+          <seealso marker="erts:erlang#erlang:set_cookie/2">erlang:set_cookie(node(), <anno>Cookie</anno>)</seealso>
           instead.</p>
       </desc>
     </func>
@@ -82,7 +79,7 @@
       <fsummary>Set the magic cookie for a node and verify authorization (deprecated)</fsummary>
       <type>
         <v>Node = node()</v>
-        <v>Cookie = atom()</v>
+        <v>Cookie = <seealso marker="#type-cookie">cookie()</seealso></v>
       </type>
       <desc>
         <p>Equivalent to
@@ -90,18 +87,14 @@
       </desc>
     </func>
     <func>
-      <name>node_cookie(Node, Cookie) -> yes | no</name>
+      <name name="node_cookie" arity="2"/>
       <fsummary>Set the magic cookie for a node and verify authorization (deprecated)</fsummary>
-      <type>
-        <v>Node = node()</v>
-        <v>Cookie = atom()</v>
-      </type>
       <desc>
-        <p>Sets the magic cookie of <c>Node</c> to <c>Cookie</c>, and
+        <p>Sets the magic cookie of <c><anno>Node</anno></c> to <c><anno>Cookie</anno></c>, and
           verifies the status of the authorization.
           Equivalent to calling
-          <seealso marker="erts:erlang#erlang:set_cookie/2">erlang:set_cookie(Node, Cookie)</seealso>, followed by
-          <seealso marker="#is_auth/1">auth:is_auth(Node)</seealso>.</p>
+          <seealso marker="erts:erlang#erlang:set_cookie/2">erlang:set_cookie(<anno>Node</anno>, <anno>Cookie</anno>)</seealso>, followed by
+          <seealso marker="#is_auth/1">auth:is_auth(<anno>Node</anno>)</seealso>.</p>
       </desc>
     </func>
   </funcs>
-- 
cgit v1.2.3