#9 oxygenize SDMXType Rdoc

opensdmx · Oct 26, 2015 · 220939c · 220939c
1 parent 74ff855
commit 220939c
Show file tree

Hide file tree

Showing 4 changed files with 82 additions and 46 deletions.
diff --git a/R/Class-SDMXType.R b/R/Class-SDMXType.R
@@ -1,7 +1,18 @@
-# E.Blondel - 2013/06/09
-#=======================
-
-#SDMX abstract class
+#' @name SDMXType
+#' @docType class
+#' @aliases SDMXType-class
+#' @title Class "SDMXType"
+#' 
+#' @description A basic class to handle the type of a SDMX-ML document
+#' 
+#' @slot type Object of class "character" giving the type of the SDMX-ML document
+#' 
+#' @section Warning:
+#' this class is not useful in itself, but all SDMX non-abstract classes will 
+#' encapsulate it as slot, when parsing an SDMX-ML document.
+#'          
+#' @author Emmanuel Blondel, \email{emmanuel.blondel1@@gmail.com}
+#' 
 setClass("SDMXType",
 		representation(
 				type = "character"

diff --git a/R/SDMXType-methods.R b/R/SDMXType-methods.R
@@ -1,6 +1,24 @@
-# E.Blondel - 2013/06/10
-#=======================
-
+#' @name SDMXType
+#' @rdname SDMXType
+#' @aliases SDMXType,SDMXType-method
+#' 
+#' @usage
+#' SDMXType(xmlObj)
+#' 
+#' @param xmlObj object of class "XMLInternalDocument derived from XML package
+#' @return an object of class "SDMXType"
+#' 
+#' @note
+#' At now, the following types have been implemented and successfully tested:
+#'  - \code{StructureType},
+#'  - \code{GenericDataType},
+#'  - \code{CompactDataType},
+#'  - \code{StructureSpecificDataType},
+#'  - \code{UtilityDataType},
+#'  - \code{MessageGroupType}
+#' 
+#' @seealso \link{readSDMX}
+#'
 SDMXType <- function(xmlObj){
 	new("SDMXType", type = type.SDMXType(xmlObj));
 }

diff --git a/man/SDMXType-class.Rd b/man/SDMXType-class.Rd
diff --git a/man/SDMXType.Rd b/man/SDMXType.Rd
@@ -0,0 +1,46 @@
+% Generated by roxygen2 (4.1.1): do not edit by hand
+% Please edit documentation in R/Class-SDMXType.R, R/SDMXType-methods.R
+\docType{class}
+\name{SDMXType}
+\alias{SDMXType}
+\alias{SDMXType,SDMXType-method}
+\alias{SDMXType-class}
+\title{Class "SDMXType"}
+\usage{
+SDMXType(xmlObj)
+}
+\arguments{
+\item{xmlObj}{object of class "XMLInternalDocument derived from XML package}
+}
+\value{
+an object of class "SDMXType"
+}
+\description{
+A basic class to handle the type of a SDMX-ML document
+}
+\section{Slots}{
+
+\describe{
+\item{\code{type}}{Object of class "character" giving the type of the SDMX-ML document}
+}}
+\note{
+At now, the following types have been implemented and successfully tested:
+ - \code{StructureType},
+ - \code{GenericDataType},
+ - \code{CompactDataType},
+ - \code{StructureSpecificDataType},
+ - \code{UtilityDataType},
+ - \code{MessageGroupType}
+}
+\section{Warning}{
+
+this class is not useful in itself, but all SDMX non-abstract classes will
+encapsulate it as slot, when parsing an SDMX-ML document.
+}
+\author{
+Emmanuel Blondel, \email{emmanuel.blondel1@gmail.com}
+}
+\seealso{
+\link{readSDMX}
+}
+