[Rprotobuf-commits] r926 - in pkg: . inst man

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

Author: edd
Date: 2014-12-02 04:39:46 +0100 (Tue, 02 Dec 2014)
New Revision: 926

Modified:
   pkg/ChangeLog
   pkg/inst/NEWS.Rd
   pkg/man/Descriptor-class.Rd
   pkg/man/EnumDescriptor-class.Rd
   pkg/man/Message-class.Rd
Log:
minor fixes for documentation


Modified: pkg/ChangeLog
===================================================================
--- pkg/ChangeLog	2014-12-02 00:40:56 UTC (rev 925)
+++ pkg/ChangeLog	2014-12-02 03:39:46 UTC (rev 926)
@@ -1,3 +1,9 @@
+2014-12-01  Dirk Eddelbuettel  <edd at debian.org>
+
+	* man/Message-class.Rd: Completed documentation
+	* man/Descriptor-class.Rd: Ditto
+	* man/EnumDescriptor-class.Rd: Ditto
+
 2014-12-01  Murray Stokely  <mstokely at google.com>
 
 	* R/wrapper_ZeroCopyInputStream.R: Avoid file.create for getting

Modified: pkg/inst/NEWS.Rd
===================================================================
--- pkg/inst/NEWS.Rd	2014-12-02 00:40:56 UTC (rev 925)
+++ pkg/inst/NEWS.Rd	2014-12-02 03:39:46 UTC (rev 926)
@@ -26,6 +26,7 @@
     \item Use \code{normalizePath} instead of creating a temporary
     file with \code{file.create} when getting absolute path names.
     \item Add unit tests for all of the above.
+  }
 }
 
 \section{Changes in RProtoBuf version 0.4.1 (2014-03-25)}{

Modified: pkg/man/Descriptor-class.Rd
===================================================================
--- pkg/man/Descriptor-class.Rd	2014-12-02 00:40:56 UTC (rev 925)
+++ pkg/man/Descriptor-class.Rd	2014-12-02 03:39:46 UTC (rev 926)
@@ -15,6 +15,9 @@
 \alias{field,Descriptor-method}
 \alias{nested_type,Descriptor-method}
 \alias{enum_type,Descriptor,ANY,ANY-method}
+\alias{[[,Descriptor-method}
+\alias{names,Descriptor-method}
+\alias{length,Descriptor-method}
 
 \title{Class "Descriptor" }
 \description{ full descriptive information about a protocol buffer 
@@ -81,6 +84,9 @@
 			If \code{name} is used, the enum type will be retrieved
 			using its name, with the \code{FindEnumTypeByName} C++ method
 	}
+    \item{[[}{\code{signature(x = "Descriptor")}: extracts a field identified by its name or declared tag number}
+    \item{names}{\code{signature(x = "Descriptor")} : extracts names of this descriptor}
+    \item{length}{\code{signature(x = "Descriptor")} : extracts length of this descriptor}
 
   }
 }

Modified: pkg/man/EnumDescriptor-class.Rd
===================================================================
--- pkg/man/EnumDescriptor-class.Rd	2014-12-02 00:40:56 UTC (rev 925)
+++ pkg/man/EnumDescriptor-class.Rd	2014-12-02 03:39:46 UTC (rev 926)
@@ -18,6 +18,9 @@
 \alias{value-methods}
 \alias{value,EnumDescriptor-method}
 
+\alias{[[,EnumDescriptor-method}
+\alias{names,EnumDescriptor-method}
+
 \title{Class "EnumDescriptor"  }
 \description{ R representation of an enum descriptor. This 
 is a thin wrapper around the \code{EnumDescriptor} c++ class. }
@@ -60,6 +63,8 @@
       using the name of the constant, using the \code{FindValueByName}
       C++ method.
     }
+    \item{[[}{\code{signature(x = "EnumDescriptor")}: extracts field identified by its name or declared tag number}
+    \item{names}{\code{signature(x = "EnumDescriptor")} : extracts names of this enum}
   }
   	
 }

Modified: pkg/man/Message-class.Rd
===================================================================
--- pkg/man/Message-class.Rd	2014-12-02 00:40:56 UTC (rev 925)
+++ pkg/man/Message-class.Rd	2014-12-02 03:39:46 UTC (rev 926)
@@ -11,6 +11,7 @@
 \alias{show,Message-method}
 \alias{update,Message-method}
 \alias{length,Message-method}
+\alias{names,Message-method}
 \alias{str,Message-method}
 \alias{toString,Message-method}
 \alias{identical,Message,Message-method}
@@ -68,7 +69,9 @@
     \item{==}{\code{signature(e1 = "Message", e2 = "Message")}: Same as \code{identical} }
     \item{!=}{\code{signature(e1 = "Message", e2 = "Message")}: Negation of \code{identical} }
     \item{all.equal}{\code{signature(e1 = "Message", e2 = "Message")}: Test near equality }
-     }
+    \item{names}{\code{signature(x = "Message")}: extracts the names of the message. }
+
+  }
 }
 \references{ 
 	The \code{Message} class from the C++ proto library.