From da15f706159db83100dde62b2e3069ae46e88c09 Mon Sep 17 00:00:00 2001
From: Siri Hansen <siri@erlang.org>
Date: Tue, 1 Jul 2014 15:25:33 +0200
Subject: Fix bug in alarm_handler documentation

The documentation erroneously specified that clear_alarm/1 would clear
*all* alarms with id AlarmId. This is now corrected according to the
implementation - only the latest received alarm with the given AlarmId
is cleared.
---
 lib/sasl/doc/src/alarm_handler.xml | 12 ++++++++----
 1 file changed, 8 insertions(+), 4 deletions(-)

(limited to 'lib/sasl/doc/src/alarm_handler.xml')

diff --git a/lib/sasl/doc/src/alarm_handler.xml b/lib/sasl/doc/src/alarm_handler.xml
index ab3041137e..e4def7c7f5 100644
--- a/lib/sasl/doc/src/alarm_handler.xml
+++ b/lib/sasl/doc/src/alarm_handler.xml
@@ -5,7 +5,7 @@
   <header>
     <copyright>
       <year>1996</year>
-      <year>2013</year>
+      <year>2014</year>
       <holder>Ericsson AB, All Rights Reserved</holder>
     </copyright>
     <legalnotice>
@@ -87,7 +87,9 @@
         <v>AlarmId = term()</v>
       </type>
       <desc>
-        <p>Clears all alarms with id <c>AlarmId</c>.
+	<p>Sends the <c>clear_alarm</c> event to all event handlers.</p>
+        <p>When receiving this event, the default simple handler
+          clears the latest received alarm with id <c>AlarmId</c>.
           </p>
       </desc>
     </func>
@@ -109,8 +111,10 @@
         <v>AlarmDescription = term()</v>
       </type>
       <desc>
-        <p>Sets an alarm with id <c>AlarmId</c>. This id is used at a
-          later stage when the alarm is cleared.
+	<p>Sends the <c>set_alarm</c> event to all event handlers.</p>
+        <p>When receiving this event, the default simple handler
+          stores the alarm. The <c>AlarmId</c> identifies the alarm
+          and is used when the alarm is cleared.
           </p>
       </desc>
     </func>
-- 
cgit v1.2.3