[rkward-cvs] SF.net SVN: rkward:[3791] trunk/rkward/rkward/rbackend/rpackages/XiMpLe
m-eik at users.sourceforge.net
m-eik at users.sourceforge.net
Sat Sep 17 10:40:45 UTC 2011
Revision: 3791
http://rkward.svn.sourceforge.net/rkward/?rev=3791&view=rev
Author: m-eik
Date: 2011-09-17 10:40:45 +0000 (Sat, 17 Sep 2011)
Log Message:
-----------
XiMpLe: added docs for S4 classes
Modified Paths:
--------------
trunk/rkward/rkward/rbackend/rpackages/XiMpLe/ChangeLog
trunk/rkward/rkward/rbackend/rpackages/XiMpLe/DESCRIPTION
trunk/rkward/rkward/rbackend/rpackages/XiMpLe/R/XiMpLe-package.R
trunk/rkward/rkward/rbackend/rpackages/XiMpLe/R/XiMpLe.doc-class.R
trunk/rkward/rkward/rbackend/rpackages/XiMpLe/R/XiMpLe.node-class.R
trunk/rkward/rkward/rbackend/rpackages/XiMpLe/inst/CITATION
trunk/rkward/rkward/rbackend/rpackages/XiMpLe/man/XiMpLe-package.Rd
Added Paths:
-----------
trunk/rkward/rkward/rbackend/rpackages/XiMpLe/man/XiMpLe.doc-class.Rd
trunk/rkward/rkward/rbackend/rpackages/XiMpLe/man/XiMpLe.node-class.Rd
Modified: trunk/rkward/rkward/rbackend/rpackages/XiMpLe/ChangeLog
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/XiMpLe/ChangeLog 2011-09-16 15:38:51 UTC (rev 3790)
+++ trunk/rkward/rkward/rbackend/rpackages/XiMpLe/ChangeLog 2011-09-17 10:40:45 UTC (rev 3791)
@@ -1,5 +1,8 @@
ChangeLog for package XiMpLe
+## 0.03-2 (2011-09-17)
+ - added docs for classed XiMpLe.doc and XiMpLe.node
+
## 0.03-1 (2011-09-11)
- fixed outstanding issue with complex value structures
- changed "Author at R" to "Authors at R" in DESCRIPTION (for R >= 2.14)
Modified: trunk/rkward/rkward/rbackend/rpackages/XiMpLe/DESCRIPTION
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/XiMpLe/DESCRIPTION 2011-09-16 15:38:51 UTC (rev 3790)
+++ trunk/rkward/rkward/rbackend/rpackages/XiMpLe/DESCRIPTION 2011-09-17 10:40:45 UTC (rev 3791)
@@ -4,7 +4,7 @@
Author: m.eik michalke <meik.michalke at hhu.de>
Maintainer: m.eik michalke <meik.michalke at hhu.de>
Depends:
- R (>= 2.9.0)
+ R (>= 2.9.0),methods
Enhances: rkward
Description: This package provides a simple XML tree
parser/generator. It includes functions to read XML
@@ -17,10 +17,10 @@
Encoding: UTF-8
LazyLoad: yes
URL: http://rkward.sourceforge.net
-Author at R: c(person(given="Meik", family="Michalke",
- email="meik.michalke at hhu.de"))
-Version: 0.03-1
-Date: 2011-09-12
+Authors at R: c(person(given="Meik", family="Michalke",
+ email="meik.michalke at hhu.de", role=c("aut", "cre")))
+Version: 0.03-2
+Date: 2011-09-17
Collate:
'XiMpLe.node-class.R'
'XiMpLe.doc-class.R'
Modified: trunk/rkward/rkward/rbackend/rpackages/XiMpLe/R/XiMpLe-package.R
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/XiMpLe/R/XiMpLe-package.R 2011-09-16 15:38:51 UTC (rev 3790)
+++ trunk/rkward/rkward/rbackend/rpackages/XiMpLe/R/XiMpLe-package.R 2011-09-17 10:40:45 UTC (rev 3791)
@@ -3,9 +3,9 @@
#' \tabular{ll}{
#' Package: \tab XiMpLe\cr
#' Type: \tab Package\cr
-#' Version: \tab 0.03-1\cr
-#' Date: \tab 2011-09-12\cr
-#' Depends: \tab R (>= 2.9.0)\cr
+#' Version: \tab 0.03-2\cr
+#' Date: \tab 2011-09-17\cr
+#' Depends: \tab R (>= 2.9.0),methods\cr
#' Enhances: \tab rkward\cr
#' Encoding: \tab UTF-8\cr
#' License: \tab GPL (>= 3)\cr
Modified: trunk/rkward/rkward/rbackend/rpackages/XiMpLe/R/XiMpLe.doc-class.R
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/XiMpLe/R/XiMpLe.doc-class.R 2011-09-16 15:38:51 UTC (rev 3790)
+++ trunk/rkward/rkward/rbackend/rpackages/XiMpLe/R/XiMpLe.doc-class.R 2011-09-17 10:40:45 UTC (rev 3791)
@@ -1,6 +1,25 @@
+## temporarily turned off most of the roxygen comments
+## class docs will remain static until roxygen2 supports "@slot"
+
+# Class XiMpLe.doc
+#
+# This class is used for objects that are returned by \code{\link[XiMpLe:parseXMLTree]{parseXMLTree}}.
+#
+# @title S4 class XiMpLe.doc
+# @slot file Name of the file.
+# @slot xml XML declaration of the file.
+# @slot dtd Doctype definition of the file.
+# @slot children A list of objects of class XiMpLe.node, representing the DOM structure of the XML document.
+# @name XiMpLe.doc,-class
+# @aliases XiMpLe.doc-class XiMpLe.doc,-class
#' @include XiMpLe.node-class.R
#' @import methods
+# @keywords classes
+#' @noRd
+# @rdname XiMpLe.doc-class
+# @exportClass XiMpLe.doc
#' @export
+
setClass("XiMpLe.doc",
representation=representation(
file="character",
Modified: trunk/rkward/rkward/rbackend/rpackages/XiMpLe/R/XiMpLe.node-class.R
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/XiMpLe/R/XiMpLe.node-class.R 2011-09-16 15:38:51 UTC (rev 3790)
+++ trunk/rkward/rkward/rbackend/rpackages/XiMpLe/R/XiMpLe.node-class.R 2011-09-17 10:40:45 UTC (rev 3791)
@@ -1,5 +1,31 @@
+# Class XiMpLe.node
+#
+# This class is used to create DOM trees of XML documents, like objects that are returned
+# by \code{\link[XiMpLe:parseXMLTree]{parseXMLTree}}.
+#
+# There are certain special values predefined for the \code{name} slot to easily create special XML elements:
+# \describe{
+# \item{\code{name=""}}{If the name is an empty character string, a pseudo node is created,
+# \code{\link[XiMpLe:pasteXMLNode]{pasteXMLNode}} will paste its \code{value} as plain text.}
+# \item{\code{name="!--"}}{Creates a comment tag, i.e., this will comment out all its \code{children}.}
+# \item{\code{name="![CDATA["}}{Creates a CDATA section and places all its \code{children} in it.}
+# }
+#
+# @title S4 class XiMpLe.node
+# @slot name Name of the node (i.e., the XML tag identifier). For special names see details.
+# @slot attributes A list of named character values, representing the attributes of this node.
+# @slot children A list of further objects of class XiMpLe.node, representing child nodes of this node.
+# @slot value Plain text to be used as the enclosed value of this node. Set to \code{value=""} if you
+# want a childless node to be forced into an non-empty pair of start and end tags by \code{\link[XiMpLe:pasteXMLNode]{pasteXMLNode}}.
+# @name XiMpLe.node,-class
+# @aliases XiMpLe.node-class XiMpLe.node,-class
#' @import methods
+# @keywords classes
+#' @noRd
+# @rdname XiMpLe.node-class
+# @exportClass XiMpLe.node
#' @export
+
setClass("XiMpLe.node",
representation=representation(
name="character",
Modified: trunk/rkward/rkward/rbackend/rpackages/XiMpLe/inst/CITATION
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/XiMpLe/inst/CITATION 2011-09-16 15:38:51 UTC (rev 3790)
+++ trunk/rkward/rkward/rbackend/rpackages/XiMpLe/inst/CITATION 2011-09-17 10:40:45 UTC (rev 3791)
@@ -1,13 +1,14 @@
bibentry("Manual",
title="XiMpLe: A simple XML tree parser and generator",
- author=c(person(given="Meik", family="Michalke", email="meik.michalke at hhu.de")),
+ author=c(person(given="Meik", family="Michalke", email="meik.michalke at hhu.de",
+ role=c("aut", "cre"))),
year="2011",
- note="(Version 0.03-1)",
+ note="(Version 0.03-2)",
url="http://rkward.sourceforge.net",
textVersion =
paste("Michalke, M. (2011). ",
- "XiMpLe: A simple XML tree parser and generator (Version 0.03-1). ",
+ "XiMpLe: A simple XML tree parser and generator (Version 0.03-2). ",
"Available from http://rkward.sourceforge.net",
sep=""),
Modified: trunk/rkward/rkward/rbackend/rpackages/XiMpLe/man/XiMpLe-package.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/XiMpLe/man/XiMpLe-package.Rd 2011-09-16 15:38:51 UTC (rev 3790)
+++ trunk/rkward/rkward/rbackend/rpackages/XiMpLe/man/XiMpLe-package.Rd 2011-09-17 10:40:45 UTC (rev 3791)
@@ -8,10 +8,10 @@
}
\details{
\tabular{ll}{ Package: \tab XiMpLe\cr Type: \tab
- Package\cr Version: \tab 0.03-1\cr Date: \tab
- 2011-09-12\cr Depends: \tab R (>= 2.9.0)\cr Enhances:
- \tab rkward\cr Encoding: \tab UTF-8\cr License: \tab GPL
- (>= 3)\cr LazyLoad: \tab yes\cr URL: \tab
+ Package\cr Version: \tab 0.03-2\cr Date: \tab
+ 2011-09-17\cr Depends: \tab R (>= 2.9.0),methods\cr
+ Enhances: \tab rkward\cr Encoding: \tab UTF-8\cr License:
+ \tab GPL (>= 3)\cr LazyLoad: \tab yes\cr URL: \tab
http://rkward.sourceforge.net\cr }
This package provides a simple XML tree parser/generator.
Added: trunk/rkward/rkward/rbackend/rpackages/XiMpLe/man/XiMpLe.doc-class.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/XiMpLe/man/XiMpLe.doc-class.Rd (rev 0)
+++ trunk/rkward/rkward/rbackend/rpackages/XiMpLe/man/XiMpLe.doc-class.Rd 2011-09-17 10:40:45 UTC (rev 3791)
@@ -0,0 +1,9 @@
+\name{XiMpLe.doc-class}
+\title{S4 class XiMpLe.doc}
+\description{Class XiMpLe.doc}
+\details{This class is used for objects that are returned by \code{\link[XiMpLe:parseXMLTree]{parseXMLTree}}.}
+\alias{XiMpLe.doc-class}
+\alias{XiMpLe.doc,-class}
+\keyword{classes}
+\section{Slots}{\describe{\item{\code{file}:}{(\code{\link{character}}) Name of the file.}\item{\code{xml}:}{(\code{\link{list}}) XML declaration of the file.}\item{\code{dtd}:}{(\code{\link{list}}) Doctype definition of the file.}\item{\code{children}:}{(\code{\link{list}}) A list of objects of class XiMpLe.node, representing the DOM structure of the XML document.}}}
+
Added: trunk/rkward/rkward/rbackend/rpackages/XiMpLe/man/XiMpLe.node-class.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/XiMpLe/man/XiMpLe.node-class.Rd (rev 0)
+++ trunk/rkward/rkward/rbackend/rpackages/XiMpLe/man/XiMpLe.node-class.Rd 2011-09-17 10:40:45 UTC (rev 3791)
@@ -0,0 +1,19 @@
+\name{XiMpLe.node-class}
+\title{S4 class XiMpLe.node}
+\description{Class XiMpLe.node}
+\details{This class is used to create DOM trees of XML documents, like objects that are returned
+by \code{\link[XiMpLe:parseXMLTree]{parseXMLTree}}.
+
+There are certain special values predefined for the \code{name} slot to easily create special XML elements:
+\describe{
+\item{\code{name=""}}{If the name is an empty character string, a pseudo node is created,
+\code{\link[XiMpLe:pasteXMLNode]{pasteXMLNode}} will paste its \code{value} as plain text.}
+\item{\code{name="!--"}}{Creates a comment tag, i.e., this will comment out all its \code{children}.}
+\item{\code{name="![CDATA["}}{Creates a CDATA section and places all its \code{children} in it.}
+}}
+\alias{XiMpLe.node-class}
+\alias{XiMpLe.node,-class}
+\keyword{classes}
+\section{Slots}{\describe{\item{\code{name}:}{(\code{\link{character}}) Name of the node (i.e., the XML tag identifier). For special names see details.}\item{\code{attributes}:}{(\code{\link{list}}) A list of named character values, representing the attributes of this node.}\item{\code{children}:}{(\code{\link{list}}) A list of further objects of class XiMpLe.node, representing child nodes of this node.}\item{\code{value}:}{(\code{\link{character}}) Plain text to be used as the enclosed value of this node. Set to \code{value=""} if you
+want a childless node to be forced into an non-empty pair of start and end tags by \code{\link[XiMpLe:pasteXMLNode]{pasteXMLNode}}.}}}
+
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
More information about the rkward-tracker
mailing list