From 229d0d8ca88bc344bed89e46541b325c1d267996 Mon Sep 17 00:00:00 2001 From: Hans Bolinder Date: Fri, 6 May 2011 15:58:09 +0200 Subject: r Use Erlang specs and types for documentation --- lib/stdlib/doc/src/log_mf_h.xml | 31 +++++++++++++++---------------- 1 file changed, 15 insertions(+), 16 deletions(-) (limited to 'lib/stdlib/doc/src/log_mf_h.xml') diff --git a/lib/stdlib/doc/src/log_mf_h.xml b/lib/stdlib/doc/src/log_mf_h.xml index f8e11339a7..f2b09b58eb 100644 --- a/lib/stdlib/doc/src/log_mf_h.xml +++ b/lib/stdlib/doc/src/log_mf_h.xml @@ -43,28 +43,27 @@ report files 1, 2, .....

+ + + +

Term to be sent to + gen_event:add_handler/3.

+
+
- init(Dir, MaxBytes, MaxFiles) - init(Dir, MaxBytes, MaxFiles, Pred) -> Args + + Initiate the event handler - - Dir = string() - MaxBytes = integer() - MaxFiles = 0 < integer() < 256 - Pred = fun(Event) -> boolean() - Event = term() - Args = args() -

Initiates the event handler. This function returns - Args, which should be used in a call to - gen_event:add_handler(EventMgr, log_mf_h, Args). + Args, which should be used in a call to + gen_event:add_handler(EventMgr, log_mf_h, Args).

-

Dir specifies which directory to use for the log - files. MaxBytes specifies the size of each individual - file. MaxFiles specifies how many files are - used. Pred is a predicate function used to filter the +

Dir specifies which directory to use for the log + files. MaxBytes specifies the size of each individual + file. MaxFiles specifies how many files are + used. Pred is a predicate function used to filter the events. If no predicate function is specified, all events are logged.

-- cgit v1.2.3