diff options
author | Siri Hansen <[email protected]> | 2014-07-10 14:34:04 +0200 |
---|---|---|
committer | Siri Hansen <[email protected]> | 2014-07-10 14:34:04 +0200 |
commit | 398976f444a47ad019f8493bc6a23626589163f5 (patch) | |
tree | 7fbe10ab8c60823aa5b7c72fcc125dc20292c95c /lib/sasl | |
parent | 0a79b5b6612a0cb5997e77459bc756caf8bb0e99 (diff) | |
parent | a56f6e3e716c4a2c8f16933e1e30759381c4fdb8 (diff) | |
download | otp-398976f444a47ad019f8493bc6a23626589163f5.tar.gz otp-398976f444a47ad019f8493bc6a23626589163f5.tar.bz2 otp-398976f444a47ad019f8493bc6a23626589163f5.zip |
Merge branch 'maint'
Diffstat (limited to 'lib/sasl')
-rw-r--r-- | lib/sasl/doc/src/alarm_handler.xml | 12 |
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> |