[Roxygen-commits] r98 - in pkg: . R

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

Author: pcd
Date: 2008-07-26 23:52:55 +0200 (Sat, 26 Jul 2008)
New Revision: 98

Modified:
   pkg/R/Rd.R
   pkg/R/parse.R
   pkg/R/roxygen.R
   pkg/README
Log:
update README with new driver; docType; package documentation


Modified: pkg/R/Rd.R
===================================================================
--- pkg/R/Rd.R	2008-07-26 21:27:55 UTC (rev 97)
+++ pkg/R/Rd.R	2008-07-26 21:52:55 UTC (rev 98)
@@ -313,7 +313,8 @@
                                   'note',
                                   'author',
                                   'seealso',
-                                  'concept')
+                                  'concept',
+                                  'docType')
 
   roclet$register.parser('return',
                          function(key, expressions)

Modified: pkg/R/parse.R
===================================================================
--- pkg/R/parse.R	2008-07-26 21:27:55 UTC (rev 97)
+++ pkg/R/parse.R	2008-07-26 21:52:55 UTC (rev 98)
@@ -241,7 +241,8 @@
 #' @aliases S3class returnType
 register.preref.parsers(parse.name,
                         'S3class',
-                        'returnType')
+                        'returnType',
+                        'docType')
 
 #' Turn a binary element on; parameters are ignored.
 #' @param key parsing key

Modified: pkg/R/roxygen.R
===================================================================
--- pkg/R/roxygen.R	2008-07-26 21:27:55 UTC (rev 97)
+++ pkg/R/roxygen.R	2008-07-26 21:52:55 UTC (rev 98)
@@ -1,3 +1,11 @@
 #' No-op for sourceless files
 #' @return \code{NULL}
 roxygen <- function() NULL
+
+#' See the \link{\code{make.Rd.roclet}},
+#' \link{\code{make.namespace.roclet}},
+#' and \link{\code{make.collate.roclet}} pages for
+#' an overview of roxygen tags.
+#' @alias roxygen-package roxygen
+#' @docType package
+roxygen()

Modified: pkg/README
===================================================================
--- pkg/README	2008-07-26 21:27:55 UTC (rev 97)
+++ pkg/README	2008-07-26 21:52:55 UTC (rev 98)
@@ -6,29 +6,23 @@
 
 1.1. Execution
 
-The driver in the `sandbox' directory, `main.R', parses an arbitrary
-source file; but defaults to `example.R' from the original GSoC
-proposal.
+The driver in the `sandbox' directory, `roxygenize.R', creates a package
+skeleton `pkg.roxygen'; populates its `man' directory with Rd files from
+the source; generates a NAMESPACE; and modifies the Collate field in
+`DESCRIPTION'.
 
-Upon execution, one should see a parse-tree of parsed elements
-(represented as lists); accompanied by a srcref of the apposite
-object:
+Run it from the root of the repository (i.e. one above the package
+root):
 
-    $ cd sandbox
-    $ R --vanilla --slave --args example.R < main.R
+    R --slave --vanilla < pkg/sandbox/roxygenize.R
 
-    List of 3
-     $ 1:List of 6
-      ..$ description: chr "This class represents a person."
-      ..$ slot       :List of 2
-      .. ..$ name       : chr "fullname"
-      .. ..$ description: chr "The full name of the person"
+If all goes well, you should be able to run `R CMD check' on the
+newly created directory; and find `roxygen-manual.pdf' in
+`pkg.roxygen.Rcheck':
 
-    ...
+    R CMD check pkg.roxygen && \
+    xpdf pkg.roxygen.Rcheck/roxygen-manual.pdf
 
-To test the Rd, namespace and collate roclets: there are similarly
-`Rd.R', `namespace.R' and `collate.R' in the same directory.
-
 1.2. TODO
 
 * Create a driver (possibly used by `R CMD roxygen') which farms out