[Roxygen-devel] Roxygen & S4

meik michalke meik.michalke at uni-duesseldorf.de
Sun Mar 25 22:24:32 CEST 2012


hi,

shouldn't docs for generics also have a usage section? mine somehow don't. 

roxygenizing this file:

<rxTest.R>
#' Test method
#'
#' Just a test. Where's the usage section?
#'
#' @param object An object of class \code{numeric}.
#' @keywords methods
#' @export
#' @docType methods
#' @rdname rxTest-methods
setGeneric("rxTest", function(object){standardGeneric("rxTest")})

#' @aliases rxTest,numeric-method
#' @rdname rxTest-methods
setMethod("rxTest", signature(object="numeric"), function(object){
  print(object)
})
</rxTest.R>

gives me this:

<rxTest.Rd>
\docType{methods}
\name{rxTest}
\alias{rxTest}
\alias{rxTest,numeric-method}
\title{Test method}
\arguments{
  \item{object}{An object of class \code{numeric}.}
}
\description{
  Just a test. Where's the usage section?
}
\keyword{methods}
</rxTest.Rd>


defining @usage manually didn't help, the section remains omitted. :: m.eik

-- 
dipl. psych. meik michalke
institut f"ur experimentelle psychologie
abt. f"ur diagnostik und differentielle psychologie
heinrich-heine-universit"at d-40204 d"usseldorf
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 198 bytes
Desc: This is a digitally signed message part.
URL: <http://lists.r-forge.r-project.org/pipermail/roxygen-devel/attachments/20120325/e20230b0/attachment.pgp>


More information about the Roxygen-devel mailing list