aboutsummaryrefslogtreecommitdiffstats
path: root/lib/sasl/doc/src
diff options
context:
space:
mode:
authorSiri Hansen <[email protected]>2014-07-01 15:25:33 +0200
committerSiri Hansen <[email protected]>2014-07-10 14:30:04 +0200
commitda15f706159db83100dde62b2e3069ae46e88c09 (patch)
tree5b3ee7011e907accb6bbffcd3a90706483af94eb /lib/sasl/doc/src
parentd2ade9b27432a1f7342e231d0d8b12467c3d3d77 (diff)
downloadotp-da15f706159db83100dde62b2e3069ae46e88c09.tar.gz
otp-da15f706159db83100dde62b2e3069ae46e88c09.tar.bz2
otp-da15f706159db83100dde62b2e3069ae46e88c09.zip
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.
Diffstat (limited to 'lib/sasl/doc/src')
-rw-r--r--lib/sasl/doc/src/alarm_handler.xml12
1 files changed, 8 insertions, 4 deletions
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>