sasl: Editorial changes

1 files changed, 41 insertions, 43 deletions

diff --git a/lib/sasl/doc/src/alarm_handler.xml b/lib/sasl/doc/src/alarm_handler.xml
index b98f22d2a1..68076ba28d 100644
--- a/lib/sasl/doc/src/alarm_handler.xml
+++ b/lib/sasl/doc/src/alarm_handler.xml
@@ -37,94 +37,92 @@
   <module>alarm_handler</module>
   <modulesummary>An Alarm Handling Process</modulesummary>
   <description>
-    <p>The alarm handler process is a <c>gen_event</c> event manager
-      process which receives alarms in the system. This process is not
-      intended to be a complete alarm handler. It defines a
-      place to which alarms can be sent. One simple event handler is
-      installed in the alarm handler at start-up, but users are
-      encouraged to write and install their own handlers.
-      </p>
+    <p>The alarm handler process is a 
+      <seealso marker="stdlib:gen_event"><c>gen_event</c></seealso> 
+      event manager process that receives alarms in the system. 
+      This process is not intended to be a complete alarm handler. 
+      It defines a place to which alarms can be sent. One simple event 
+      handler is installed in the alarm handler at startup, but users 
+      are encouraged to write and install their own handlers.</p>
     <p>The simple event handler sends all alarms as info reports to
-      the error logger, and saves all of them in a list which can be
-      passed to a user defined event handler, which may be installed at
-      a later stage. The list can grow large if many alarms are
-      generated. So it is a good reason to install a better user defined
-      handler.
-      </p>
-    <p>There are functions to set and clear alarms. The format of
-      alarms are defined by the user. For example, an event handler
-      for SNMP could be defined, together with an alarm MIB.
-      </p>
-    <p>The alarm handler is part of the SASL application. 
-      </p>
+      the error logger, and saves all in a list. This list can be
+      passed to a user-defined event handler, which can be installed
+      later. The list can grow large if many alarms are generated.
+      This is a good reason to install a better user-defined
+      handler.</p>
+    <p>Functions are provided to set and clear alarms. The alarm
+      format is defined by the user. For example, an event handler
+      for SNMP can be defined, together with an alarm Management
+      Information Base (MIB).</p>
+    <p>The alarm handler is part of the <c>SASL</c> application.</p>
     <p>When writing new event handlers for the alarm handler, the
-      following events must be handled:
-      </p>
+      following events must be handled:</p>
     <taglist>
       <tag><c>{set_alarm, {AlarmId, AlarmDescr}}</c></tag>
       <item>
         <p>This event is generated by
-          <c>alarm_handler:set_alarm({AlarmId, AlarmDecsr})</c>.
-          </p>
+          <c>alarm_handler:set_alarm({AlarmId, AlarmDecsr})</c>.</p>
       </item>
       <tag><c>{clear_alarm, AlarmId}</c></tag>
       <item>
         <p>This event is
-          generated by <c>alarm_handler:clear_alarm(AlarmId)</c>.
-          </p>
+          generated by <c>alarm_handler:clear_alarm(AlarmId)</c>.</p>
       </item>
     </taglist>
     <p>The default simple handler is called <c>alarm_handler</c> and
-      it may be exchanged by calling <c>gen_event:swap_handler/3</c>
-      as <c>gen_event:swap_handler(alarm_handler, {alarm_handler, swap}, {NewHandler, Args})</c>. <c>NewHandler:init({Args, {alarm_handler, Alarms}})</c> is called. Refer to gen_event(3)
-      for further details.
-      </p>
+      it can be exchanged by calling 
+      <seealso marker="stdlib:gen_event#swap_handler/3"><c>gen_event:swap_handler/3</c></seealso>
+      as <c>gen_event:swap_handler(alarm_handler, {alarm_handler, swap},
+      {NewHandler, Args})</c>. <c>NewHandler:init({Args, {alarm_handler,
+      Alarms}})</c> is called. For more details, see
+      <seealso marker="stdlib:gen_event"><c>gen_event(3)</c></seealso>
+      in <c>STDLIB</c>.</p>
   </description>
+
   <funcs>
     <func>
       <name>clear_alarm(AlarmId) -> void()</name>
-      <fsummary>Clear the specified alarms</fsummary>
+      <fsummary>Clears the specified alarms.</fsummary>
       <type>
         <v>AlarmId = term()</v>
       </type>
       <desc>
-	<p>Sends the <c>clear_alarm</c> event to all event handlers.</p>
+	<p>Sends event <c>clear_alarm</c> 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>
+          clears the latest received alarm with id <c>AlarmId</c>.</p>
       </desc>
     </func>
+
     <func>
       <name>get_alarms() -> [alarm()]</name>
-      <fsummary>Get all active alarms</fsummary>
+      <fsummary>Gets all active alarms.</fsummary>
       <desc>
         <p>Returns a list of all active alarms. This function can only
-          be used when the simple handler is installed.
-          </p>
+          be used when the simple handler is installed.</p>
       </desc>
     </func>
+
     <func>
       <name>set_alarm(alarm())</name>
-      <fsummary>Set an alarm with an id</fsummary>
+      <fsummary>Sets an alarm with an id.</fsummary>
       <type>
         <v>alarm() = {AlarmId, AlarmDescription}</v>
         <v>AlarmId = term()</v>
         <v>AlarmDescription = term()</v>
       </type>
       <desc>
-	<p>Sends the <c>set_alarm</c> event to all event handlers.</p>
+	<p>Sends event <c>set_alarm</c> 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>
+          stores the alarm. <c>AlarmId</c> identifies the alarm
+          and is used when the alarm is cleared.</p>
       </desc>
     </func>
   </funcs>
 
   <section>
     <title>See Also</title>
-    <p>error_logger(3), gen_event(3) 
-      </p>
+    <p><seealso marker="kernel:error_logger"><c>error_logger(3)</c></seealso>,
+      <seealso marker="stdlib:gen_event"><c>gen_event(3)</c></seealso></p>
   </section>
 </erlref>