diff options
| author | Siri Hansen <[email protected]> | 2014-07-10 14:30:54 +0200 |
|---|---|---|
| committer | Siri Hansen <[email protected]> | 2014-07-10 14:30:54 +0200 |
| commit | a56f6e3e716c4a2c8f16933e1e30759381c4fdb8 (patch) | |
| tree | 50fdc92bcc6a60d03423f3e53192f6579a77aef6 | |
| parent | 11bb83d08db64fec91021b4c77b23a365bbbc8ce (diff) | |
| parent | da15f706159db83100dde62b2e3069ae46e88c09 (diff) | |
| download | otp-a56f6e3e716c4a2c8f16933e1e30759381c4fdb8.tar.gz otp-a56f6e3e716c4a2c8f16933e1e30759381c4fdb8.tar.bz2 otp-a56f6e3e716c4a2c8f16933e1e30759381c4fdb8.zip | |
Merge branch 'siri/alarm_handler-doc/OTP-12025' into maint
* siri/alarm_handler-doc/OTP-12025:
Fix bug in alarm_handler documentation
| -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> |