summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorAdam Kocoloski <adam@cloudant.com>2010-05-10 21:14:25 -0400
committerAdam Kocoloski <adam@cloudant.com>2010-05-10 21:14:25 -0400
commit1819b3aff71f49087e98c671e3ce3a388be98543 (patch)
tree84a198d74bf7cd586bc8f2b1045a467c2cfe682e /src
parent04de7e4c03eaae39d914fd2c88e99300dbf53cd9 (diff)
Better docs for rexi_monitor
Diffstat (limited to 'src')
-rw-r--r--src/rexi_monitor.erl3
1 files changed, 2 insertions, 1 deletions
diff --git a/src/rexi_monitor.erl b/src/rexi_monitor.erl
index b4c00f23..7e16048c 100644
--- a/src/rexi_monitor.erl
+++ b/src/rexi_monitor.erl
@@ -4,7 +4,8 @@
-include_lib("eunit/include/eunit.hrl").
%% @doc spawn_links a process which monitors the supplied list of items and
-%% returns the process ID.
+%% returns the process ID. If a monitored process exits, the caller will
+%% receive a {rexi_DOWN, MonitoringPid, DeadPid, Reason} message.
-spec start([pid() | atom() | {atom(),atom()}]) -> pid().
start(Procs) ->
Parent = self(),