/misc/RdSum

 1###########################################################################/**
 2#
 3# @RdocMethod summary
 4#
 5# @title "Summarize the properties of an object"
 6#
 7# \description{
 8#       @get "title".
 9# }
10#
11# @synopsis
12#
13# \arguments{
14#       \item{object}{An object}
15#       \item{...}{Not used.}
16# }
17#
18# \value{
19#  Returns a PSRootSummary object.
20# }
21#
22# \examples{
23#
24#       # create an object
25#       a<-NucleotideAlphabet()
26#       # get a summary
27#       summary(a)
28# }
29#
30# @author
31#
32# \seealso{
33#       @seeclass
34# }
35#
36#*/###########################################################################