[Rcpp-commits] r900 - pkg/Rcpp/src/Rcpp

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

Author: romain
Date: 2010-03-15 09:26:44 +0100 (Mon, 15 Mar 2010)
New Revision: 900

Modified:
   pkg/Rcpp/src/Rcpp/S4.h
Log:
some more documentation

Modified: pkg/Rcpp/src/Rcpp/S4.h
===================================================================
--- pkg/Rcpp/src/Rcpp/S4.h	2010-03-14 18:49:42 UTC (rev 899)
+++ pkg/Rcpp/src/Rcpp/S4.h	2010-03-15 08:26:44 UTC (rev 900)
@@ -27,13 +27,38 @@
 
 namespace Rcpp{ 
 
+/**
+ * S4 object
+ */
 class S4 : public RObject{
 public:
 	S4() ;
+	
+	/**
+	 * checks that x is an S4 object and wrap it.
+	 *
+	 * @param x must be an S4 object
+	 */
 	S4(SEXP x); 
+	
+	/**
+	 * copy constructor
+	 *
+	 * @param other other S4 object
+	 */
 	S4(const S4& other) ;
+	
+	/**
+	 * assignment operator. 
+	 */
 	S4& operator=( const S4& other);
 	
+	/**
+	 * Creates an S4 object of the requested class. 
+	 *
+	 * @param klass name of the target S4 class
+	 * @throw not_s4 if klass does not map to a known S4 class
+	 */
 	S4( const std::string& klass ) ;
 	
 } ;