File: convertComment.SmartComments.Rd

package info (click to toggle)
r-cran-r.utils 2.5.0-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 2,936 kB
  • sloc: sh: 18; makefile: 6
file content (41 lines) | stat: -rwxr-xr-x 909 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Do not modify this file since it was automatically generated from:
% 
%  SmartComments.R
% 
% by the Rdoc compiler part of the R.oo package.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

 \name{convertComment.SmartComments}
\alias{convertComment.SmartComments}
\alias{SmartComments.convertComment}
\alias{convertComment,SmartComments-method}

 \title{Converts a single smart comment to R code}

 \description{
   Converts a single smart comment to R code.
 }

 \usage{
\method{convertComment}{SmartComments}(...)
}

 \arguments{
  \item{...}{Not used.}
 }

 \value{
   Should return single \code{\link[base]{character}} of valid \R code.
 }

 \author{Henrik Bengtsson}

 \seealso{
   For more information see \code{\link{SmartComments}}.
 }


\keyword{internal}
\keyword{methods}
\keyword{programming}