| Line 1... |
Line 1... |
| 1 |
% File src/library/methods/man/promptMethods.Rd
|
1 |
% File src/library/methods/man/promptMethods.Rd
|
| 2 |
% Part of the R package, https://www.R-project.org
|
2 |
% Part of the R package, https://www.R-project.org
|
| 3 |
% Copyright 1995-2007 R Core Team
|
3 |
% Copyright 1995-2018 R Core Team
|
| 4 |
% Distributed under GPL 2 or later
|
4 |
% Distributed under GPL 2 or later
|
| 5 |
|
5 |
|
| 6 |
\name{promptMethods}
|
6 |
\name{promptMethods}
|
| 7 |
\alias{promptMethods}
|
7 |
\alias{promptMethods}
|
| 8 |
\title{ Generate a Shell for Documentation of Formal Methods }
|
8 |
\title{ Generate a Shell for Documentation of Formal Methods }
|
| Line 19... |
Line 19... |
| 19 |
\item{filename}{usually, a connection or a character string giving the
|
19 |
\item{filename}{usually, a connection or a character string giving the
|
| 20 |
name of the file to which the documentation shell should be written.
|
20 |
name of the file to which the documentation shell should be written.
|
| 21 |
The default corresponds to the coded topic name for these methods
|
21 |
The default corresponds to the coded topic name for these methods
|
| 22 |
(currently, \code{f} followed by \code{"-methods.Rd"}). Can also be
|
22 |
(currently, \code{f} followed by \code{"-methods.Rd"}). Can also be
|
| 23 |
\code{FALSE} or \code{NA} (see below).}
|
23 |
\code{FALSE} or \code{NA} (see below).}
|
| 24 |
\item{methods}{Optional methods list object giving the methods to be
|
24 |
\item{methods}{optional \code{"\linkS4class{listOfMethods}"} object giving the methods to be
|
| 25 |
documented. By default, the first methods object for this generic
|
25 |
documented. By default, the first methods object for this generic
|
| 26 |
is used (for example, if the current global environment has some
|
26 |
is used (for example, if the current global environment has some
|
| 27 |
methods for \code{f}, these would be documented).
|
27 |
methods for \code{f}, these would be documented).
|
| 28 |
|
28 |
|
| 29 |
If this argument is supplied, it is likely to be
|
29 |
If this argument is supplied, it is likely to be
|
| 30 |
\code{getMethods(f, where)}, with \code{where} some package
|
30 |
\code{\link{findMethods}(f, where)}, with \code{where} some package
|
| 31 |
containing methods for \code{f}.}
|
31 |
containing methods for \code{f}.}
|
| 32 |
}
|
32 |
}
|
| 33 |
\value{
|
33 |
\value{
|
| 34 |
If \code{filename} is \code{FALSE}, the text generated;
|
34 |
If \code{filename} is \code{FALSE}, the text generated;
|
| 35 |
if \code{filename} is \code{NA}, a list-style representation of the
|
35 |
if \code{filename} is \code{NA}, a list-style representation of the
|
The R Project SVN
R