[Roxygen-commits] r72 - pkg/R

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

Author: pcd
Date: 2008-07-21 14:58:13 +0200 (Mon, 21 Jul 2008)
New Revision: 72

Modified:
   pkg/R/roclet.R
Log:
comment the roclet, even though intra-object comments are ignored


Modified: pkg/R/roclet.R
===================================================================
--- pkg/R/roclet.R	2008-07-21 12:31:50 UTC (rev 71)
+++ pkg/R/roclet.R	2008-07-21 12:58:13 UTC (rev 72)
@@ -8,7 +8,7 @@
 #' \item{register.parsers}{takes \code{parser} and \code{keys}}
 #' \item{register.default.parser}{takes a \code{key}}
 #' \item{register.default.parsers}{take \code{parsers}}
-#' \item{parse}{parses material returned by \code{parse.files}}
+#' \item{parse}{parses material contained in files}
 #'
 #' @param parse.default the default parser taking \code{key}
 #' and \code{value}
@@ -29,20 +29,37 @@
 
   roclet$parsers <- list()
 
+  #' Register parser in the parser table.
+  #' @param key key upon which to register
+  #' @param parser the parser to register
+  #' @return \code{NULL}
   roclet$register.parser <- function(key, parser)
     roclet$parsers[[key]] <- parser
 
+  #' Register many parsers at once.
+  #' @param parser the parser to register
+  #' @param \dots the keys under which to register
+  #' @return \code{NULL}
   roclet$register.parsers <- function(parser, ...)
     for (key in c(...))
       roclet$register.parser(key, parser)
 
+  #' Register a default parser.
+  #' @param key key upon which to register
+  #' @return \code{NULL}
   roclet$register.default.parser <- function(key)
     roclet$parsers[[key]] <- parse.default
 
+  #' Register many default parsers.
+  #' @param \dots the keys under which to register
+  #' @return \code{NULL}
   roclet$register.default.parsers <- function(...)
     for (parser in c(...))
       roclet$register.default.parser(parser)
 
+  #' Parse material contained in files.
+  #' @param \dots the files to parse
+  #' @return \code{NULL}
   roclet$parse <- function(...) {
     key.values <- function(partitum)
       zip.list(attributes(partitum)$names, partitum)