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/heart.xml | 16 +++++-----------
 1 file changed, 5 insertions(+), 11 deletions(-)

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

diff --git a/lib/kernel/doc/src/heart.xml b/lib/kernel/doc/src/heart.xml
index 0df699572d..e2dbcbe63d 100644
--- a/lib/kernel/doc/src/heart.xml
+++ b/lib/kernel/doc/src/heart.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>
@@ -76,11 +76,8 @@
   </description>
   <funcs>
     <func>
-      <name>set_cmd(Cmd) -> ok | {error, {bad_cmd, Cmd}}</name>
+      <name name="set_cmd" arity="1"/>
       <fsummary>Set a temporary reboot command</fsummary>
-      <type>
-        <v>Cmd = string()</v>
-      </type>
       <desc>
         <p>Sets a temporary reboot command. This command is used if 
           a <c>HEART_COMMAND</c> other than the one specified with
@@ -88,12 +85,12 @@
           the system. The new Erlang runtime system will (if it
           misbehaves) use the environment variable
           <c>HEART_COMMAND</c> to reboot.</p>
-        <p>Limitations: The length of the <c>Cmd</c> command string
+        <p>Limitations: The length of the <c><anno>Cmd</anno></c> command string
           must be less than 2047 characters.</p>
       </desc>
     </func>
     <func>
-      <name>clear_cmd() -> ok</name>
+      <name name="clear_cmd" arity="0"/>
       <fsummary>Clear the temporary boot command</fsummary>
       <desc>
         <p>Clears the temporary boot command. If the system terminates,
@@ -101,11 +98,8 @@
       </desc>
     </func>
     <func>
-      <name>get_cmd() -> {ok, Cmd}</name>
+      <name name="get_cmd" arity="0"/>
       <fsummary>Get the temporary reboot command</fsummary>
-      <type>
-        <v>Cmd = string()</v>
-      </type>
       <desc>
         <p>Get the temporary reboot command. If the command is cleared,
           the empty string will be returned.</p>
-- 
cgit v1.2.3