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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
|
###########################################################################/**
# @RdocClass RspComment
#
# @title "The RspComment class"
#
# \description{
# @classhierarchy
#
# An RspComment is an @see "RspConstruct" that represents an RSP comment,
# which are of format \code{<\%-- ... --\%>}, \code{<\%--- ... ---\%>}
# and so on. They can also be so called "empty" RSP comments of format
# \code{<\%-\%>}, \code{<\%--\%>}, \code{<\%---\%>} and so on.
# }
#
# @synopsis
#
# \arguments{
# \item{str}{A @character string.}
# \item{...}{Not used.}
# }
#
# \section{Fields and Methods}{
# @allmethods
# }
#
# @author
#
# @keyword internal
#*/###########################################################################
setConstructorS3("RspComment", function(str=character(), ...) {
extend(RspConstruct(str), "RspComment")
})
#########################################################################/**
# @RdocMethod getComment
#
# @title "Gets the comment"
#
# \description{
# @get "title".
# }
#
# @synopsis
#
# \arguments{
# \item{...}{Not used.}
# }
#
# \value{
# Returns a @character string.
# }
#
# @author
#
# \seealso{
# @seeclass
# }
#*/#########################################################################
setMethodS3("getComment", "RspComment", function(comment, ...) {
as.character(comment)
})
setMethodS3("asRspString", "RspComment", function(object, ...) {
body <- unclass(object)
suffixSpecs <- attr(object, "suffixSpecs")
fmtstr <- "%s%s"
fmtstr <- paste(escFmtStr(.rspBracketOpen), fmtstr, escFmtStr(.rspBracketClose), sep="")
s <- sprintf(fmtstr, body, suffixSpecs)
RspString(s)
})
|
