[Roxygen-commits] r168 - in pkg: R man src
noreply at r-forge.r-project.org
noreply at r-forge.r-project.org
Tue Aug 12 03:58:32 CEST 2008
Author: pcd
Date: 2008-08-12 03:58:32 +0200 (Tue, 12 Aug 2008)
New Revision: 168
Modified:
pkg/R/Rd.R
pkg/R/callgraph.R
pkg/R/collate.R
pkg/R/namespace.R
pkg/R/roxygenize.R
pkg/man/roxygenize.Rd
pkg/src/Makefile
pkg/src/roxygen
Log:
hack to satisfy R CMD check: how to document tags outside of roclet constructors
Modified: pkg/R/Rd.R
===================================================================
--- pkg/R/Rd.R 2008-08-12 01:58:28 UTC (rev 167)
+++ pkg/R/Rd.R 2008-08-12 01:58:32 UTC (rev 168)
@@ -5,6 +5,12 @@
#' @include parse.R
roxygen()
+#' Rd value parsers
+#' @name name
+#' @aliases name aliases title usage references concept
+#' note seealso example examples keywords return author
+#' TODO
+#' @seealso make.Rd.roclet
register.preref.parsers(parse.value,
'name',
'aliases',
@@ -21,21 +27,37 @@
'author',
'TODO')
-register.preref.parsers(parse.name.description,
+#' Rd name-description parsers
+#' @name param
+#' @aliases param method
+#' @seealso make.Rd.roclet
+nregister.preref.parsers(parse.name.description,
'param',
'method')
+#' Rd name parser
+#' @name docType
+#' @seealso make.Rd.roclet
register.preref.parsers(parse.name,
'docType')
+#' Rd srcref parsers
+#' @name setClass
+#' @seealso make.Rd.roclet
register.srcref.parser('setClass',
function(pivot, expression)
list(S4class=car(expression)))
+#' Rd srcref parsers
+#' @name setGeneric
+#' @seealso make.Rd.roclet
register.srcref.parser('setGeneric',
function(pivot, expression)
list(S4generic=car(expression)))
+#' Rd srcref parsers
+#' @name setMethod
+#' @seealso make.Rd.roclet
register.srcref.parser('setMethod',
function(pivot, expression)
list(S4method=car(expression),
Modified: pkg/R/callgraph.R
===================================================================
--- pkg/R/callgraph.R 2008-08-12 01:58:28 UTC (rev 167)
+++ pkg/R/callgraph.R 2008-08-12 01:58:32 UTC (rev 168)
@@ -3,9 +3,16 @@
#' @include functional.R
roxygen()
+#' Callgraph value parsers
+#' @name callGraphDepth
+#' @seealso make.callgraph.roclet
register.preref.parsers(parse.value,
'callGraphDepth')
+#' Callgraph toggle parsers
+#' @name callGraph
+#' @aliases callGraph callGraphPrimitives
+#' @seealso make.callgraph.roclet
register.preref.parsers(parse.toggle,
'callGraph',
'callGraphPrimitives')
Modified: pkg/R/collate.R
===================================================================
--- pkg/R/collate.R 2008-08-12 01:58:28 UTC (rev 167)
+++ pkg/R/collate.R 2008-08-12 01:58:32 UTC (rev 168)
@@ -6,6 +6,9 @@
#' @include parse.R
roxygen()
+#' Collate value parser
+#' @name include
+#' @seealso make.collate.roclet
register.preref.parsers(parse.value,
'include')
Modified: pkg/R/namespace.R
===================================================================
--- pkg/R/namespace.R 2008-08-12 01:58:28 UTC (rev 167)
+++ pkg/R/namespace.R 2008-08-12 01:58:32 UTC (rev 168)
@@ -4,9 +4,19 @@
#' @include string.R
roxygen()
+#' Namespace default parser
+#' @name export
+#' @title Namespace default parser
+#' @seealso make.namespace.parser
register.preref.parsers(parse.default,
'export')
+#' Namespace value parsers
+#' @name exportClass
+#' @aliases exportClass exportMethod exportPattern
+#' S3method import importFrom importClassesFrom
+#' importMethodsFrom
+#' @seealso make.namespace.roclet
register.preref.parsers(parse.value,
'exportClass',
'exportMethod',
Modified: pkg/R/roxygenize.R
===================================================================
--- pkg/R/roxygenize.R 2008-08-12 01:58:28 UTC (rev 167)
+++ pkg/R/roxygenize.R 2008-08-12 01:58:32 UTC (rev 168)
@@ -64,6 +64,9 @@
#' @param roxygen.dir whither to copy roxygen files
#' @param copy.package copies the package over before
#' adding/manipulating files.
+#' @param overwrite overwrite target files
+#' @param unlink.target unlink target directory before
+#' processing files
#' @return \code{NULL}
#' @callGraph
#' @callGraphDepth 1
Modified: pkg/man/roxygenize.Rd
===================================================================
--- pkg/man/roxygenize.Rd 2008-08-12 01:58:28 UTC (rev 167)
+++ pkg/man/roxygenize.Rd 2008-08-12 01:58:32 UTC (rev 168)
@@ -10,4 +10,7 @@
\arguments{\item{package.dir}{the package's top directory}
\item{roxygen.dir}{whither to copy roxygen files}
\item{copy.package}{copies the package over before
-adding/manipulating files.}}
+adding/manipulating files.}
+\item{overwrite}{overwrite target files}
+\item{unlink.target}{unlink target directory before
+processing files}}
Modified: pkg/src/Makefile
===================================================================
--- pkg/src/Makefile 2008-08-12 01:58:28 UTC (rev 167)
+++ pkg/src/Makefile 2008-08-12 01:58:32 UTC (rev 168)
@@ -1,7 +1,8 @@
ROXYGEN=$(R_HOME)/bin/roxygen
+FAKE_OBJ=roxygen.so
all: roxygen
- @touch roxygen.so && \
+ @touch $(FAKE_OBJ) && \
install $< $(ROXYGEN) || \
echo --- R CMD roxygen will be unavailable. ---
Modified: pkg/src/roxygen
===================================================================
--- pkg/src/roxygen 2008-08-12 01:58:28 UTC (rev 167)
+++ pkg/src/roxygen 2008-08-12 01:58:32 UTC (rev 168)
@@ -12,11 +12,10 @@
With -d (Destructive), roxygen operates in place; otherwise, TARGET
defaults to \`SOURCE.roxygen'.
-With -u (Unlink), roxygen deletes TARGET before copying the processed
-files thither.
+With -u (Unlink), roxygen deletes TARGET before processing files.
-WARNING: Be careful with -u (Unlink) when SOURCE and TARGET are
-the same.
+WARNING: Be careful using -u (Unlink) when SOURCE and TARGET are
+the same or with -d (Destructive).
Options:
-d (Destructive) operate in place on SOURCE
More information about the Roxygen-commits
mailing list