[Rprotobuf-commits] r405 - pkg/man

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

Author: edd
Date: 2011-01-08 03:21:12 +0100 (Sat, 08 Jan 2011)
New Revision: 405

Modified:
   pkg/man/EnumDescriptor-class.Rd
   pkg/man/EnumValueDescriptor-class.Rd
Log:
one missing alias and tiny bit of reindenting


Modified: pkg/man/EnumDescriptor-class.Rd
===================================================================
--- pkg/man/EnumDescriptor-class.Rd	2011-01-08 02:04:09 UTC (rev 404)
+++ pkg/man/EnumDescriptor-class.Rd	2011-01-08 02:21:12 UTC (rev 405)
@@ -36,27 +36,27 @@
   \describe{
     \item{show}{\code{signature(object = "EnumDescriptor")}: small information }
     \item{as.character}{\code{signature(x = "EnumDescriptor")}: 
-  	  	  returns the debug string of the enum descriptor. 
-  	  	  This is retrieved by a call to the \code{DebugString}
-  	      method of the EnumDescriptor object.  }
-  	\item{toString}{\code{signature(x = "EnumDescriptor")}: same as \code{as.character} }
-  	\item{$}{\code{signature(x = "EnumDescriptor")}: get the 
-  	number associated with the name}
-  	\item{containing_type}{\code{signature(object = "EnumDescriptor")} : returns a \linkS4class{Descriptor} of the message type that contains this enum descriptor, or NULL if this is a top level enum descriptor.}
-  	\item{length}{\code{signature(x = "EnumDescriptor")} : number of constants in this enum.}
-  	\item{value_count}{\code{signature(object = "EnumDescriptor")} : number of constants in this enum.}
-  	\item{value}{\code{signature(object = "EnumDescriptor")} : extracts an \linkS4class{EnumValueDescriptor}.
-  		Exactly one argument of \code{index}, \code{number} or \code{name} has to be 
-  		used. 
-  		If \code{index} is used, the enum value descriptor is retrieved
-  		by position, using the \code{value} method of the C++ class. 
-  		If \code{number} is used, the enum value descripror is retrieved
-  		using the value of the constant, using the \code{FindValueByNumber}
-  		C++ method. 
-  		If \code{name} is used, the enum value descriptor is retrieved
-  		using the name of the constant, using the \code{FindValueByName}
-  		C++ method.
-  	}
+      returns the debug string of the enum descriptor. 
+      This is retrieved by a call to the \code{DebugString}
+      method of the EnumDescriptor object.  }
+    \item{toString}{\code{signature(x = "EnumDescriptor")}: same as \code{as.character} }
+    \item{$}{\code{signature(x = "EnumDescriptor")}: get the 
+      number associated with the name}
+    \item{containing_type}{\code{signature(object = "EnumDescriptor")} : returns a \linkS4class{Descriptor} of the message type that contains this enum descriptor, or NULL if this is a top level enum descriptor.}
+    \item{length}{\code{signature(x = "EnumDescriptor")} : number of constants in this enum.}
+    \item{value_count}{\code{signature(object = "EnumDescriptor")} : number of constants in this enum.}
+    \item{value}{\code{signature(object = "EnumDescriptor")} : extracts an \linkS4class{EnumValueDescriptor}.
+      Exactly one argument of \code{index}, \code{number} or \code{name} has to be 
+      used. 
+      If \code{index} is used, the enum value descriptor is retrieved
+      by position, using the \code{value} method of the C++ class. 
+      If \code{number} is used, the enum value descripror is retrieved
+      using the value of the constant, using the \code{FindValueByNumber}
+      C++ method. 
+      If \code{name} is used, the enum value descriptor is retrieved
+      using the name of the constant, using the \code{FindValueByName}
+      C++ method.
+    }
   }
   	
 }

Modified: pkg/man/EnumValueDescriptor-class.Rd
===================================================================
--- pkg/man/EnumValueDescriptor-class.Rd	2011-01-08 02:04:09 UTC (rev 404)
+++ pkg/man/EnumValueDescriptor-class.Rd	2011-01-08 02:21:12 UTC (rev 405)
@@ -6,34 +6,37 @@
 \alias{as.character,EnumValueDescriptor-method}
 \alias{toString,EnumValueDescriptor-method}
 \alias{$,EnumValueDescriptor-method}
+\alias{name,EnumValueDescriptor-method}
 \alias{enum_type,EnumValueDescriptor,missing,missing-method}
 
 \title{Class "EnumValueDescriptor"  }
 \description{ R representation of an enum value descriptor. This 
-is a thin wrapper around the \code{EnumValueDescriptor} c++ class. }
+  is a thin wrapper around the \code{EnumValueDescriptor} c++ class. }
 \section{Objects from the Class}{
-Objects of this class are typically retrieved with the 
-\code{value} method of the \linkS4class{EnumDescriptor} class
+  Objects of this class are typically retrieved with the 
+  \code{value} method of the \linkS4class{EnumDescriptor} class
 }
 \section{Slots}{
   \describe{
   	  \item{\code{pointer}:}{external pointer to the \code{EnumValueDescriptor} instance}
+  	  \item{\code{name}:}{ simple name of the enum }
+  	  \item{\code{full_name}:}{fully qualified name }
   }
 }
 \section{Methods}{
   \describe{
     \item{show}{\code{signature(object = "EnumValueDescriptor")}: small information }
     \item{as.character}{\code{signature(x = "EnumValueDescriptor")}: 
-  	  	  returns the debug string of the enum descriptor. 
-  	  	  This is retrieved by a call to the \code{DebugString}
-  	      method of the EnumDescriptor object.  }
-  	\item{toString}{\code{signature(x = "EnumValueDescriptor")}: same as \code{as.character} }
-  	\item{$}{\code{signature(x = "EnumValueDescriptor")}: invoke pseudo methods }
-  	\item{enum_type}{\code{signature(object = "EnumDescriptor")} : retrieves the \linkS4class{EnumDescriptor} related to this value descriptor.}
+      returns the debug string of the enum descriptor. 
+      This is retrieved by a call to the \code{DebugString}
+      method of the EnumDescriptor object.  }
+    \item{toString}{\code{signature(x = "EnumValueDescriptor")}: same as \code{as.character} }
+    \item{$}{\code{signature(x = "EnumValueDescriptor")}: invoke pseudo methods }
+    \item{enum_type}{\code{signature(object = "EnumDescriptor")} : retrieves the \linkS4class{EnumDescriptor} related to this value descriptor.}
   }
   	
 }
 \references{ The \code{EnumValueDescriptor} C++ class. 
-	\url{http://code.google.com/apis/protocolbuffers/docs/reference/cpp/google.protobuf.descriptor.html#EnumValueDescriptor} }
+  \url{http://code.google.com/apis/protocolbuffers/docs/reference/cpp/google.protobuf.descriptor.html#EnumValueDescriptor} }
 \author{ Romain Francois <francoisromain at free.fr> }
 \keyword{classes}