[Rcpp-commits] r2860 - pkg/RcppBDT/man

[noreply at r-forge.r-project.org]

Author: edd
Date: 2011-01-11 20:27:15 +0100 (Tue, 11 Jan 2011)
New Revision: 2860

Modified:
   pkg/RcppBDT/man/bdtEnv.Rd
   pkg/RcppBDT/man/dateFuntions.Rd
Log:
changes in use of environment: corresponding manual page changes


Modified: pkg/RcppBDT/man/bdtEnv.Rd
===================================================================
--- pkg/RcppBDT/man/bdtEnv.Rd	2011-01-11 15:04:45 UTC (rev 2859)
+++ pkg/RcppBDT/man/bdtEnv.Rd	2011-01-11 19:27:15 UTC (rev 2860)
@@ -1,10 +1,13 @@
-\name{bdtEnv}
-\alias{bdtEnv}
+\name{bdt}
+\alias{bdt}
 \docType{package}
-\title{Bindings for Boost Date_Time}
+\title{Default object for RcppBDT Boost Date_Time binding}
 \description{
-  The \verb{bdtEnv} environment contains the reference class instance
-  created by means of Rcpp modules, as well as an object instance.
+  The \verb{bdt} variable is a default instance of the reference class
+  created by means of Rcpp modules.
+
+  New instances can be created using either the default constructor
+  (without argument) or the constructor using year, month, date arguments.
 }
 \details{
   Please consult the Boost documentation for (copious) details on the

Modified: pkg/RcppBDT/man/dateFuntions.Rd
===================================================================
--- pkg/RcppBDT/man/dateFuntions.Rd	2011-01-11 15:04:45 UTC (rev 2859)
+++ pkg/RcppBDT/man/dateFuntions.Rd	2011-01-11 19:27:15 UTC (rev 2860)
@@ -1,5 +1,4 @@
 \name{RcppBDT Date functions}
-\alias{getBDT}
 \alias{getEndOfBizWeek}
 \alias{getEndOfMonth}
 \alias{getYear}
@@ -44,8 +43,6 @@
 getFirstDayOfWeekInMonth(nthday, mon, year) 
 getFirstDayOfWeekAfter(dow, date) 
 getLastDayOfWeekBefore(dow, date)
-
-getBDT() 
 }
 \arguments{
   \item{date}{a \code{\link{Date}} object}
@@ -62,10 +59,6 @@
 }
 \value{
   All functions return a \code{\link{Date}} object.
-
-  The sole exception is \code{getBDT} which returns the \code{bdt}
-  instance of the class created by \code{Rcpp modules}. The Boost
-  functions are accessed via this class instance.
 }
 \details{Details of the Boost functions are provided by the Boost documentation.}
 \author{Dirk Eddelbuettel \email{edd at debian.org}}