diff options
| author | Hans Bolinder <[email protected]> | 2011-05-13 14:08:25 +0200 |
|---|---|---|
| committer | Hans Bolinder <[email protected]> | 2011-05-13 14:08:59 +0200 |
| commit | 0ccc57b1e3772deaf5650077808a38a52b1133b9 (patch) | |
| tree | ed98a14e3cda51c344a04c85db7843b274dfe56a /lib/stdlib/doc/src/log_mf_h.xml | |
| parent | 22f3c9720cb7d19a3aafac613f03aede91d6283f (diff) | |
| parent | 229d0d8ca88bc344bed89e46541b325c1d267996 (diff) | |
| download | otp-0ccc57b1e3772deaf5650077808a38a52b1133b9.tar.gz otp-0ccc57b1e3772deaf5650077808a38a52b1133b9.tar.bz2 otp-0ccc57b1e3772deaf5650077808a38a52b1133b9.zip | |
Merge branch 'hb/stdlib/doc_specs/OTP-9271' into dev
* hb/stdlib/doc_specs/OTP-9271:
Use Erlang specs and types for documentation
Conflicts:
lib/stdlib/doc/src/timer.xml
Diffstat (limited to 'lib/stdlib/doc/src/log_mf_h.xml')
| -rw-r--r-- | lib/stdlib/doc/src/log_mf_h.xml | 31 |
1 files changed, 15 insertions, 16 deletions
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 <c>1, 2, ....</c>. </p> </description> + <datatypes> + <datatype> + <name name="args"/> + <desc><p>Term to be sent to <seealso marker="gen_event#add_handler/3"> + gen_event:add_handler/3</seealso>.</p></desc> + </datatype> + </datatypes> <funcs> <func> - <name>init(Dir, MaxBytes, MaxFiles)</name> - <name>init(Dir, MaxBytes, MaxFiles, Pred) -> Args</name> + <name name="init" arity="3"/> + <name name="init" arity="4"/> <fsummary>Initiate the event handler</fsummary> - <type> - <v>Dir = string()</v> - <v>MaxBytes = integer()</v> - <v>MaxFiles = 0 < integer() < 256</v> - <v>Pred = fun(Event) -> boolean()</v> - <v>Event = term()</v> - <v>Args = args()</v> - </type> <desc> <p>Initiates the event handler. This function returns - <c>Args</c>, which should be used in a call to - <c>gen_event:add_handler(EventMgr, log_mf_h, Args)</c>. + <c><anno>Args</anno></c>, which should be used in a call to + <c>gen_event:add_handler(EventMgr, log_mf_h, <anno>Args</anno>)</c>. </p> - <p><c>Dir</c> specifies which directory to use for the log - files. <c>MaxBytes</c> specifies the size of each individual - file. <c>MaxFiles</c> specifies how many files are - used. <c>Pred</c> is a predicate function used to filter the + <p><c><anno>Dir</anno></c> specifies which directory to use for the log + files. <c><anno>MaxBytes</anno></c> specifies the size of each individual + file. <c><anno>MaxFiles</anno></c> specifies how many files are + used. <c><anno>Pred</anno></c> is a predicate function used to filter the events. If no predicate function is specified, all events are logged.</p> </desc> |