[Logging-commits] r82 - oo/pkg/man

[noreply at r-forge.r-project.org]

Author: mariotomo
Date: 2011-07-21 10:29:32 +0200 (Thu, 21 Jul 2011)
New Revision: 82

Modified:
   oo/pkg/man/Logger.Rd
Log:
better documentation of S4method.


Modified: oo/pkg/man/Logger.Rd
===================================================================
--- oo/pkg/man/Logger.Rd	2011-05-10 11:53:52 UTC (rev 81)
+++ oo/pkg/man/Logger.Rd	2011-07-21 08:29:32 UTC (rev 82)
@@ -4,6 +4,18 @@
 \name{Logger}
 \alias{Logger}
 \alias{getLogger}
+\alias{\S4method{new}{Logger}}
+\alias{\S4method{log}{Logger}}
+\alias{\S4method{setLevel}{Logger}}
+\alias{\S4method{getLevel}{Logger}}
+\alias{\S4method{addHandler}{Logger}}
+\alias{\S4method{finest}{Logger}}
+\alias{\S4method{finer}{Logger}}
+\alias{\S4method{fine}{Logger}}
+\alias{\S4method{debug}{Logger}}
+\alias{\S4method{info}{Logger}}
+\alias{\S4method{warn}{Logger}}
+\alias{\S4method{error}{Logger}}
 \title{the `Logger` reference class}
 \description{
 
@@ -11,11 +23,24 @@
 
 }
 \usage{
-logger <- Logger$new(name=name)
-logger <- getLogger(name=name)
+\S4method{new}{Logger}(name)
+getLogger(name="")
+\S4method{log}{Logger}(...)
+\S4method{setLevel}{Logger}(newLevel)
+\S4method{getLevel}{Logger}()
+\S4method{addHandler}{Logger}(...)
+\S4method{finest}{Logger}(...)
+\S4method{finer}{Logger}(...)
+\S4method{fine}{Logger}(...)
+\S4method{debug}{Logger}(...)
+\S4method{info}{Logger}(...)
+\S4method{warn}{Logger}(...)
+\S4method{error}{Logger}(...)
 }
 \arguments{
-  \item{name}{the name of the logger}
+  \item{name}{the name of the logger being created.}
+  \item{newLevel}{the new logging level of this logger.}
+  \item{\dots}{any extra arguments are passed further.}
 }
 \examples{
 basicConfig()