From 23a850984539ed86d9df102fb40bd6eecd7fdac7 Mon Sep 17 00:00:00 2001
From: crownedgrouse <eric.pailleau@wanadoo.fr>
Date: Tue, 16 Dec 2014 23:17:10 +0100
Subject:   Fix xml doc return value mnesia:(un)subscribe

---
 lib/mnesia/doc/src/Mnesia_chap5.xmlsrc | 1 +
 lib/mnesia/doc/src/mnesia.xml          | 8 +++++---
 2 files changed, 6 insertions(+), 3 deletions(-)

(limited to 'lib/mnesia/doc')

diff --git a/lib/mnesia/doc/src/Mnesia_chap5.xmlsrc b/lib/mnesia/doc/src/Mnesia_chap5.xmlsrc
index 65b950bd46..127c23e0f7 100644
--- a/lib/mnesia/doc/src/Mnesia_chap5.xmlsrc
+++ b/lib/mnesia/doc/src/Mnesia_chap5.xmlsrc
@@ -867,6 +867,7 @@ ok
   </section>
 
   <section>
+    <marker id="event_handling"></marker>
     <title>Mnesia Event Handling</title>
     <p>System events and table events are the two categories of events
       that Mnesia will generate in various situations. 
diff --git a/lib/mnesia/doc/src/mnesia.xml b/lib/mnesia/doc/src/mnesia.xml
index 72e9bd7e8f..3e3ec42890 100644
--- a/lib/mnesia/doc/src/mnesia.xml
+++ b/lib/mnesia/doc/src/mnesia.xml
@@ -2188,12 +2188,13 @@ mnesia:create_table(employee,
       </desc>
     </func>
     <func>
-      <name>subscribe(EventCategory)</name>
+      <name>subscribe(EventCategory) -> {ok, Node} | {error, Reason} </name>
       <fsummary>Subscribe to events of type <c>EventCategory</c>.</fsummary>
       <desc>
         <p>Ensures that a copy of all events of type
           <c>EventCategory</c> are sent to the caller.  The event
-          types available are described in the Mnesia User's Guide.</p>
+          types available are described in the Mnesia User's Guide at <seealso marker="Mnesia_chap5#event_handling">Mnesia Event Handling</seealso>.</p>
+        <p><c>Node</c> is the local node. For table events to be subscribed, mnesia must have a readable local copy of the table on the node.</p>        
       </desc>
     </func>
     <func>
@@ -2861,11 +2862,12 @@ raise(Name, Amount) ->
       </desc>
     </func>
     <func>
-      <name>unsubscribe(EventCategory)</name>
+      <name>unsubscribe(EventCategory) -> {ok, Node} | {error, Reason} </name>
       <fsummary>Subscribe to events of type <c>EventCategory</c>.</fsummary>
       <desc>
         <p>Stops sending events of type
           <c>EventCategory</c> to the caller.</p>
+        <p><c>Node</c> is the local node.</p>
       </desc>
     </func>
     <func>
-- 
cgit v1.2.3