[Roxygen-commits] r182 - pkg/man
noreply at r-forge.r-project.org
noreply at r-forge.r-project.org
Mon Aug 25 13:40:55 CEST 2008
Author: pcd
Date: 2008-08-25 13:40:55 +0200 (Mon, 25 Aug 2008)
New Revision: 182
Removed:
pkg/man/callGraph.Rd
pkg/man/callGraphDepth.Rd
pkg/man/docType.Rd
pkg/man/export.Rd
pkg/man/exportClass.Rd
pkg/man/name.Rd
pkg/man/param.Rd
pkg/man/setClass.Rd
pkg/man/setGeneric.Rd
pkg/man/setMethod.Rd
Modified:
pkg/man/make.Rd.roclet.Rd
pkg/man/make.callgraph.roclet.Rd
pkg/man/make.namespace.roclet.Rd
pkg/man/roxygenize.Rd
pkg/man/word.ref.Rd
Log:
updated docs
Deleted: pkg/man/callGraph.Rd
===================================================================
--- pkg/man/callGraph.Rd 2008-08-25 04:08:29 UTC (rev 181)
+++ pkg/man/callGraph.Rd 2008-08-25 11:40:55 UTC (rev 182)
@@ -1,6 +0,0 @@
-\name{callGraph}
-\title{Callgraph toggle parsers...}
-\description{Callgraph toggle parsers}
-\alias{callGraph}
-\alias{callGraphPrimitives}
-\seealso{make.callgraph.roclet}
Deleted: pkg/man/callGraphDepth.Rd
===================================================================
--- pkg/man/callGraphDepth.Rd 2008-08-25 04:08:29 UTC (rev 181)
+++ pkg/man/callGraphDepth.Rd 2008-08-25 11:40:55 UTC (rev 182)
@@ -1,5 +0,0 @@
-\name{callGraphDepth}
-\alias{callGraphDepth}
-\title{Callgraph value parsers...}
-\description{Callgraph value parsers}
-\seealso{make.callgraph.roclet}
Deleted: pkg/man/docType.Rd
===================================================================
--- pkg/man/docType.Rd 2008-08-25 04:08:29 UTC (rev 181)
+++ pkg/man/docType.Rd 2008-08-25 11:40:55 UTC (rev 182)
@@ -1,5 +0,0 @@
-\name{docType}
-\alias{docType}
-\title{Rd name parser...}
-\description{Rd name parser}
-\seealso{make.Rd.roclet}
Deleted: pkg/man/export.Rd
===================================================================
--- pkg/man/export.Rd 2008-08-25 04:08:29 UTC (rev 181)
+++ pkg/man/export.Rd 2008-08-25 11:40:55 UTC (rev 182)
@@ -1,5 +0,0 @@
-\name{export}
-\alias{export}
-\title{Namespace default parser}
-\description{Namespace default parser}
-\seealso{make.namespace.parser}
Deleted: pkg/man/exportClass.Rd
===================================================================
--- pkg/man/exportClass.Rd 2008-08-25 04:08:29 UTC (rev 181)
+++ pkg/man/exportClass.Rd 2008-08-25 11:40:55 UTC (rev 182)
@@ -1,12 +0,0 @@
-\name{exportClass}
-\title{Namespace value parsers...}
-\description{Namespace value parsers}
-\alias{exportClass}
-\alias{exportMethod}
-\alias{exportPattern}
-\alias{S3method}
-\alias{import}
-\alias{importFrom}
-\alias{importClassesFrom}
-\alias{importMethodsFrom}
-\seealso{make.namespace.roclet}
Modified: pkg/man/make.Rd.roclet.Rd
===================================================================
--- pkg/man/make.Rd.roclet.Rd 2008-08-25 04:08:29 UTC (rev 181)
+++ pkg/man/make.Rd.roclet.Rd 2008-08-25 11:40:55 UTC (rev 182)
@@ -1,5 +1,4 @@
\name{make.Rd.roclet}
-\alias{make.Rd.roclet}
\title{Make an Rd roclet which parses the given files and, if specified, populates...}
\usage{make.Rd.roclet(subdir, verbose=TRUE)}
\description{Make an Rd roclet which parses the given files and, if specified, populates
@@ -32,52 +31,72 @@
\enumerate{
\item{\code{@author}}{See \dQuote{2.1.1 Documenting functions} from
- \cite{Writing R Extensions}.}
+\cite{Writing R Extensions}.}
\item{\code{@aliases}}{A default alias is plucked from the \code{@name} or
- assignee; otherwise, \code{@alias a b ...} translates
- to \code{\alias{a}}, \code{\alias{b}}, &c.
+assignee; otherwise, \code{@alias a b ...} translates
+to \code{\alias{a}}, \code{\alias{b}}, &c.
- If you specify one alias, however, specify them all.}
+If you specify one alias, however, specify them all.}
\item{\code{@concept}}{See \dQuote{2.8 Indices} from
- \cite{Writing R Extensions}.}
+\cite{Writing R Extensions}.}
\item{\code{@example}}{Each \code{@example} tag specifies an example file
- relative to the package head; if the file resides in
- \file{tests}, for instance, it will be checked with
- \command{R CMD check}.
+relative to the package head; if the file resides in
+\file{tests}, for instance, it will be checked with
+\command{R CMD check}.
- The contents of the file will
- be concatenated under \code{\examples{...}}.}
+The contents of the file will
+be concatenated under \code{\examples{...}}.}
\item{\code{@examples}}{Verbatim examples; see \dQuote{2.1.1
- Documenting functions} from \cite{Writing R
- Extensions}.}
+Documenting functions} from \cite{Writing R
+Extensions}.}
\item{\code{@keywords}}{\code{@keywords a b ...} translates to
- \code{\keyword{a}}, \code{\keyword{b}}, &c.}
+\code{\keyword{a}}, \code{\keyword{b}}, &c.}
\item{\code{@method}}{Use \code{@method <generic> <class>} to document
- S3 functions.}
+S3 functions.}
\item{\code{@name}}{In the absense of an explicit \code{@name} tag, the
- name of an assignment is plucked from the assignee.}
+name of an assignment is plucked from the assignee.}
\item{\code{@note}}{See \dQuote{2.1.1 Documenting functions} from
- \cite{Writing R Extensions}.}
+\cite{Writing R Extensions}.}
\item{\code{@param}}{Each function variable should have a
- \code{@param <variable> <description>} specified.}
+\code{@param <variable> <description>} specified.}
\item{\code{@references}}{See \dQuote{2.1.1 Documenting functions} from
- \cite{Writing R Extensions}.}
+\cite{Writing R Extensions}.}
\item{\code{@return}}{The return value of the function, or \code{NULL}.}
\item{\code{@seealso}}{See \dQuote{2.1.1 Documenting functions} from
- \cite{Writing R Extensions}.}
+\cite{Writing R Extensions}.}
\item{\code{@title}}{A default title is plucked from the first sentence
- of the description; that is, the first phrase ending
- with a period, question mark or newline.
+of the description; that is, the first phrase ending
+with a period, question mark or newline.
- In the absence of a description, the title becomes
- the \code{@name} or assignee; lastly, it can be
- overridden with \code{@title}.}
+In the absence of a description, the title becomes
+the \code{@name} or assignee; lastly, it can be
+overridden with \code{@title}.}
\item{\code{@TODO}}{Note to developers to get off their asses.}
\item{\code{@usage}}{A default usage is construed from a function's formals,
- but can be overridden with \code{@usage} (e.g. in the case
- of multiple functions in one Rd unit).}
+but can be overridden with \code{@usage} (e.g. in the case
+of multiple functions in one Rd unit).}
}}
\value{Rd roclet}
+\alias{name}
+\alias{aliases}
+\alias{title}
+\alias{usage}
+\alias{references}
+\alias{concept}
+\alias{note}
+\alias{seealso}
+\alias{example}
+\alias{examples}
+\alias{keywords}
+\alias{return}
+\alias{author}
+\alias{TODO}
+\alias{param}
+\alias{method}
+\alias{setClass}
+\alias{setGeneric}
+\alias{setMethod}
+\alias{make.Rd.roclet}
\arguments{\item{subdir}{directory into which to place the Rd files; if
\code{NULL}, standard out.}
\item{verbose}{whether to declare what we're doing in the
@@ -100,7 +119,7 @@
#' @param ... ignored
#' @return The specialized foo
specialize.foo <- function(f, ...)
- actually.specialize(f)
+actually.specialize(f)
roclet <- make.Rd.roclet('man')
\dontrun{roclet$parse('example.R')}}
Modified: pkg/man/make.callgraph.roclet.Rd
===================================================================
--- pkg/man/make.callgraph.roclet.Rd 2008-08-25 04:08:29 UTC (rev 181)
+++ pkg/man/make.callgraph.roclet.Rd 2008-08-25 11:40:55 UTC (rev 182)
@@ -1,9 +1,20 @@
\name{make.callgraph.roclet}
-\alias{make.callgraph.roclet}
-\title{Make a callgraph roclet.}
+\title{Make a callgraph roclet which produces a static call graph...}
\usage{make.callgraph.roclet(dependencies, dir=., verbose=TRUE)}
-\description{Make a callgraph roclet.}
-\details{The callgraph roclet is awkward in the sense that
+\description{Make a callgraph roclet which produces a static call graph
+from a given function at a given depth with or without
+primitives.}
+\details{The callgraph roclet supports the following tags:
+
+\enumerate{
+\item{\code{@callGraph}}{Create a call graph of the default
+depth (currently 2), excluding primitive functions.}
+\item{\code{@callGraphPrimitives}{Create a call graph of the
+default depth (currently 2), including primitive functions.}
+\item{\code{@callGraphDepth}{Change the depth of the callgraph
+from the default of 2.}
+
+The callgraph roclet is awkward in the sense that
it requires a function's package to be loadable;
which means, like calling LaTeX multiple times,
one has to run roxygen on a package, install it,
@@ -15,6 +26,10 @@
\item{Text-only option}{Option for text-only callgraphs
(which are clearer, in my opinion)}
}}
+\alias{make.callgraph.roclet}
+\alias{callGraph}
+\alias{callGraphPrimitives}
+\alias{callGraphDepth}
\arguments{\item{dependencies}{packages required to evaluate
interesting functions}
\item{dir}{the directory to place the callgraphs in}
Modified: pkg/man/make.namespace.roclet.Rd
===================================================================
--- pkg/man/make.namespace.roclet.Rd 2008-08-25 04:08:29 UTC (rev 181)
+++ pkg/man/make.namespace.roclet.Rd 2008-08-25 11:40:55 UTC (rev 182)
@@ -1,5 +1,4 @@
\name{make.namespace.roclet}
-\alias{make.namespace.roclet}
\title{Make a namespace roclet which parses the given files and writes a list of...}
\usage{make.namespace.roclet(outfile, verbose=TRUE)}
\description{Make a namespace roclet which parses the given files and writes a list of
@@ -23,29 +22,39 @@
\enumerate{
\item{\code{@export}}{May be specified with or without value;
- if unadorned, roxygen will try to guess
- the exported value by assignee, \code{setMethod},
- \code{setClass}, etc. Otherwise,
- \code{@export f g ...}
- translates to
- \code{export(f, g, ...)}.}
+if unadorned, roxygen will try to guess
+the exported value by assignee, \code{setMethod},
+\code{setClass}, etc. Otherwise,
+\code{@export f g ...}
+translates to
+\code{export(f, g, ...)}.}
\item{\code{@exportClass}}{Overrides \code{setClass}.}
\item{\code{@exportMethod}}{Overrides \code{setMethod} or \code{setGeneric}.}
\item{\code{@exportPattern}}{See \dQuote{1.6.2 Registering S3 methods} from
- \cite{Writing R Extensions}.}
+\cite{Writing R Extensions}.}
\item{\code{@S3method}}{Overrides the export of an S3 method.}
\item{\code{@import}}{See \dQuote{1.6.1 Specifying imports and exports}
- from \cite{Writing R Extensions}.}
+from \cite{Writing R Extensions}.}
\item{\code{@importFrom}}{See \dQuote{1.6.1 Specifying imports and exports}
- from \cite{Writing R Extensions}.}
+from \cite{Writing R Extensions}.}
\item{\code{@importClassesFrom}}{See \dQuote{1.6.6 Name spaces with formal
- classes and methods} from \cite{Writing R
- Extensions}.}
+classes and methods} from \cite{Writing R
+Extensions}.}
\item{\code{@importMethodsFrom}}{See \dQuote{1.6.6 Name spaces with formal
- classes and methods} from \cite{Writing R
- Extensions}.}
+classes and methods} from \cite{Writing R
+Extensions}.}
}}
\value{Namespace roclet}
+\alias{make.namespace.roclet}
+\alias{exportClass}
+\alias{exportMethod}
+\alias{exportPattern}
+\alias{S3method}
+\alias{import}
+\alias{importFrom}
+\alias{importClassesFrom}
+\alias{importMethodsFrom}
+\alias{export}
\arguments{\item{outfile}{whither to send output; blank string means standard out}
\item{verbose}{whether to anounce what we're doing with
the \var{outfile}}}
Deleted: pkg/man/name.Rd
===================================================================
--- pkg/man/name.Rd 2008-08-25 04:08:29 UTC (rev 181)
+++ pkg/man/name.Rd 2008-08-25 11:40:55 UTC (rev 182)
@@ -1,18 +0,0 @@
-\name{name}
-\title{Rd value parsers...}
-\description{Rd value parsers}
-\alias{name}
-\alias{aliases}
-\alias{title}
-\alias{usage}
-\alias{references}
-\alias{concept}
-\alias{note}
-\alias{seealso}
-\alias{example}
-\alias{examples}
-\alias{keywords}
-\alias{return}
-\alias{author}
-\alias{TODO}
-\seealso{make.Rd.roclet}
Deleted: pkg/man/param.Rd
===================================================================
--- pkg/man/param.Rd 2008-08-25 04:08:29 UTC (rev 181)
+++ pkg/man/param.Rd 2008-08-25 11:40:55 UTC (rev 182)
@@ -1,6 +0,0 @@
-\name{param}
-\title{Rd name-description parsers...}
-\description{Rd name-description parsers}
-\alias{param}
-\alias{method}
-\seealso{make.Rd.roclet}
Modified: pkg/man/roxygenize.Rd
===================================================================
--- pkg/man/roxygenize.Rd 2008-08-25 04:08:29 UTC (rev 181)
+++ pkg/man/roxygenize.Rd 2008-08-25 11:40:55 UTC (rev 182)
@@ -8,7 +8,8 @@
\section{TODO}{Options to enable/disable specific roclet
(\command{--no-callgraphs}, etc.)}
\arguments{\item{package.dir}{the package's top directory}
-\item{roxygen.dir}{whither to copy roxygen files}
+\item{roxygen.dir}{whither to copy roxygen files; defaults to
+\file{package.roxygen}.}
\item{copy.package}{copies the package over before
adding/manipulating files.}
\item{overwrite}{overwrite target files}
Deleted: pkg/man/setClass.Rd
===================================================================
--- pkg/man/setClass.Rd 2008-08-25 04:08:29 UTC (rev 181)
+++ pkg/man/setClass.Rd 2008-08-25 11:40:55 UTC (rev 182)
@@ -1,5 +0,0 @@
-\name{setClass}
-\alias{setClass}
-\title{Rd srcref parsers...}
-\description{Rd srcref parsers}
-\seealso{make.Rd.roclet}
Deleted: pkg/man/setGeneric.Rd
===================================================================
--- pkg/man/setGeneric.Rd 2008-08-25 04:08:29 UTC (rev 181)
+++ pkg/man/setGeneric.Rd 2008-08-25 11:40:55 UTC (rev 182)
@@ -1,5 +0,0 @@
-\name{setGeneric}
-\alias{setGeneric}
-\title{Rd srcref parsers...}
-\description{Rd srcref parsers}
-\seealso{make.Rd.roclet}
Deleted: pkg/man/setMethod.Rd
===================================================================
--- pkg/man/setMethod.Rd 2008-08-25 04:08:29 UTC (rev 181)
+++ pkg/man/setMethod.Rd 2008-08-25 11:40:55 UTC (rev 182)
@@ -1,5 +0,0 @@
-\name{setMethod}
-\alias{setMethod}
-\title{Rd srcref parsers...}
-\description{Rd srcref parsers}
-\seealso{make.Rd.roclet}
Modified: pkg/man/word.ref.Rd
===================================================================
--- pkg/man/word.ref.Rd 2008-08-25 04:08:29 UTC (rev 181)
+++ pkg/man/word.ref.Rd 2008-08-25 11:40:55 UTC (rev 182)
@@ -4,8 +4,8 @@
\usage{word.ref(string, n)}
\description{Find the nth word in a string.}
\value{A list containing:
- \item{start}{the first letter of the word.}
- \item{end}{the last letter of the word.}
+\item{start}{the first letter of the word.}
+\item{end}{the last letter of the word.}
Undefined if no such word; though \code{end} may be less than
\code{start} in such a case.}
\arguments{\item{string}{the string to search in}
More information about the Roxygen-commits
mailing list