[Rprotobuf-commits] r386 - in pkg: inst man

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

Author: romain
Date: 2010-09-10 14:45:31 +0200 (Fri, 10 Sep 2010)
New Revision: 386

Added:
   pkg/man/readASCII.Rd
Modified:
   pkg/inst/ChangeLog
Log:
added doc for readASCII

Modified: pkg/inst/ChangeLog
===================================================================
--- pkg/inst/ChangeLog	2010-09-10 11:54:37 UTC (rev 385)
+++ pkg/inst/ChangeLog	2010-09-10 12:45:31 UTC (rev 386)
@@ -2,6 +2,10 @@
 
 	* DESCRIPTION: Release 0.2.0
 
+2010-09-10  Romain Francois <romain at r-enthusiasts.com>
+
+	* man/readASCII.Rd: Rd documentation for readASCII
+
 2010-08-12  Romain Francois <romain at r-enthusiasts.com>
 
 	* src/*: restore R CMD check

Added: pkg/man/readASCII.Rd
===================================================================
--- pkg/man/readASCII.Rd	                        (rev 0)
+++ pkg/man/readASCII.Rd	2010-09-10 12:45:31 UTC (rev 386)
@@ -0,0 +1,23 @@
+\name{readASCII-methods}
+\docType{methods}
+\alias{readASCII}
+\alias{readASCII-methods}
+\alias{readASCII,Descriptor,ANY-method}
+\alias{readASCII,Descriptor,character-method}
+\title{read a message in ASCII format}
+\description{
+ Method to read a Message in ASCII format
+}
+\section{Methods}{
+\describe{
+
+\item{\code{signature(descriptor = "Descriptor", input = "ANY")}}{
+Read the message from a connection (file, etc ...)
+}
+
+\item{\code{signature(descriptor = "Descriptor", input = "character")}}{
+Read the message directly from the character string
+}
+}}
+\keyword{methods}
+