diff options
| author | Michael Klishin <michael@clojurewerkz.org> | 2015-10-28 09:47:36 +0900 |
|---|---|---|
| committer | Michael Klishin <michael@clojurewerkz.org> | 2015-10-28 09:47:36 +0900 |
| commit | 123d7cf2b635e6f32dd6960dcdb80541a2bf4286 (patch) | |
| tree | 747ff389b399edbc06e393e3af44b31a6767011b /src | |
| parent | 741fbef0c9f9fc7691435eba34db68d59e4da378 (diff) | |
| download | rabbitmq-server-git-123d7cf2b635e6f32dd6960dcdb80541a2bf4286.tar.gz | |
Doc edits
Diffstat (limited to 'src')
| -rw-r--r-- | src/rabbit_alarm.erl | 8 |
1 files changed, 3 insertions, 5 deletions
diff --git a/src/rabbit_alarm.erl b/src/rabbit_alarm.erl index 6823d75a34..56e15faa27 100644 --- a/src/rabbit_alarm.erl +++ b/src/rabbit_alarm.erl @@ -90,12 +90,10 @@ start() -> stop() -> ok. -%% @doc -%% Registers handler that should be called on every resource alarm change. -%% Given call rabbit_alarm:register(Pid, {M, F, A}) the handler would be +%% Registers a handler that should be called on every resource alarm change. +%% Given a call rabbit_alarm:register(Pid, {M, F, A}), the handler would be %% called like this: `apply(M, F, A ++ [Pid, Source, Alert])', where `Source' -%% has type resource_alarm_source() and `Alert' has type resource_alert(). -%% @end +%% has the type of resource_alarm_source() and `Alert' has the type of resource_alert(). register(Pid, AlertMFA) -> gen_event:call(?SERVER, ?MODULE, {register, Pid, AlertMFA}, infinity). |