diff options
| author | Zandra Hird <[email protected]> | 2015-02-13 15:10:44 +0100 |
|---|---|---|
| committer | Zandra Hird <[email protected]> | 2015-02-13 15:10:44 +0100 |
| commit | 61ba469b7c5aa2ea68eba3268544543be5d7b0d6 (patch) | |
| tree | 26bfbbc48ce5b21098d9ef6fff32521fd01f053c /lib/mnesia/doc/src | |
| parent | b0e9b2040221d880910c89f27b06dfef39105e39 (diff) | |
| parent | 23a850984539ed86d9df102fb40bd6eecd7fdac7 (diff) | |
| download | otp-61ba469b7c5aa2ea68eba3268544543be5d7b0d6.tar.gz otp-61ba469b7c5aa2ea68eba3268544543be5d7b0d6.tar.bz2 otp-61ba469b7c5aa2ea68eba3268544543be5d7b0d6.zip | |
Merge branch 'crownedgrouse/fix_mnesia_subscribe_doc' into maint
* crownedgrouse/fix_mnesia_subscribe_doc:
Fix xml doc return value mnesia:(un)subscribe
Diffstat (limited to 'lib/mnesia/doc/src')
| -rw-r--r-- | lib/mnesia/doc/src/Mnesia_chap5.xmlsrc | 1 | ||||
| -rw-r--r-- | lib/mnesia/doc/src/mnesia.xml | 8 |
2 files changed, 6 insertions, 3 deletions
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 c23c2cb226..5e450cbb3a 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> |