The R Project SVN R

Rev

Rev 26000 | Rev 41508 | Go to most recent revision | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 26000 Rev 26530
Line 5... Line 5...
5 
  Assembles all relevant slot and method information for a class, with
 5 
  Assembles all relevant slot and method information for a class, with
6 
  minimal markup for Rd processing; no QC facilities at present.
 6 
  minimal markup for Rd processing; no QC facilities at present.
7 
}
 7 
}
8 
\usage{
 8 
\usage{
9 
promptClass(clName, filename = NULL, type = "class",
 9 
promptClass(clName, filename = NULL, type = "class",
10 
            keywords = "classes", where = -1)
 10 
            keywords = "classes", where = topenv(parent.frame()))
11 
}
 11 
}
12 
\arguments{
 12 
\arguments{
13 
  \item{clName}{a character string naming the class to be documented.}
 13 
  \item{clName}{a character string naming the class to be documented.}
14 
  \item{filename}{usually, a connection or a character string giving the
 14 
  \item{filename}{usually, a connection or a character string giving the
15 
    name of the file to which the documentation shell should be written.
 15 
    name of the file to which the documentation shell should be written.
16 
    The default corresponds to a file whose name is the topic name for
 16 
    The default corresponds to a file whose name is the topic name for
17 
    the class documentation, followed by \code{".Rd"}.  Can also be
 17 
    the class documentation, followed by \code{".Rd"}.  Can also be
18 
    \code{NA} (see below).}
 18 
    \code{NA} (see below).}
19 
  \item{type}{The documentation type to be declared in the output
 19 
  \item{type}{the documentation type to be declared in the output file.}
20 
    file.}
 - 
 
21 
  \item{keywords}{The keywords to include in the shell of the
 20 
  \item{keywords}{the keywords to include in the shell of the
22 
    documentation.  The keyword \code{"classes"} should be one of
 21 
    documentation.  The keyword \code{"classes"} should be one of
23 
    them.}
 22 
    them.}
24 
  \item{where}{ where to look for the definition of the class and of
 23 
  \item{where}{where to look for the definition of the class and of
- 
 
 24 
    methods that use it.
25 
    methods that use it:  by default, anywhere in the current search
 25 
    %%FIXME: By default, anywhere in the current search list.
26 
    list.}
 26 
  }
27 
}
 27 
}
28 
\details{
28 
\details{
29 
  The class definition is found on the search list.  Using that
 29 
  The class definition is found on the search list.  Using that
30 
  definition, information about classes extended and slots is
 30 
  definition, information about classes extended and slots is
31 
  determined.
 31 
  determined.
32 
 
 32 
 
33 
  In addition, the currently available generics with methods for this
 33 
  In addition, the currently available generics with methods for this
Line 108... Line 108...
108 
promptClass("trackMultiCurve", stdout())
 108 
promptClass("trackMultiCurve", stdout())
109 
 
 109 
 
110 
promptClass("track", stdout())
 110 
promptClass("track", stdout())
111 
}
 111 
}
112 
\dontrun{> promptClass("track")
 112 
\dontrun{> promptClass("track")
113 
A shell of class documentation has been written to the
113 
A shell of class documentation has been written to the
114 
file "track-class.Rd".
 114 
file "track-class.Rd".
115 
}}
 115 
}}
116 
 
 116 
 
117 
\keyword{programming}
 117 
\keyword{programming}
118 
\keyword{classes}
 118 
\keyword{classes}