[Sciviews-commits] r169 - in pkg/svTools: . man

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

Author: romain
Date: 2009-08-06 21:36:37 +0200 (Thu, 06 Aug 2009)
New Revision: 169

Added:
   pkg/svTools/man/CompletePlusWrap.Rd
   pkg/svTools/man/namespaceParser.Rd
Modified:
   pkg/svTools/NAMESPACE
Log:
+doc

Modified: pkg/svTools/NAMESPACE
===================================================================
--- pkg/svTools/NAMESPACE	2009-08-06 18:47:20 UTC (rev 168)
+++ pkg/svTools/NAMESPACE	2009-08-06 19:36:37 UTC (rev 169)
@@ -14,13 +14,13 @@
 # export( emptyError )
 
 # parseError.R
-export( parseError )
+# export( parseError )
 
 # tryParse.R
-export( tryParse )
+# export( tryParse )
 
 # trySource.R
-export( trySource )
+# export( trySource )
 
 # check_description.R
 export( check_description )
@@ -38,7 +38,7 @@
 export( namespaceComplete )
 
 # check_namespace.R
-export( namespaceParser )
+# export( namespaceParser )
    
 # packages.R
 # export( packwebdesc       )
@@ -47,7 +47,7 @@
 export( loadedPackages    )
 
 # rdparse.R
-export( rdparse )
+# export( rdparse )
 
 # S3method( print, rsitesearch )
 # S3method( head, rsitesearch )

Added: pkg/svTools/man/CompletePlusWrap.Rd
===================================================================
--- pkg/svTools/man/CompletePlusWrap.Rd	                        (rev 0)
+++ pkg/svTools/man/CompletePlusWrap.Rd	2009-08-06 19:36:37 UTC (rev 169)
@@ -0,0 +1,30 @@
+\name{CompletePlusWrap}
+\Rdversion{1.1}
+\alias{CompletePlusWrap}
+\title{
+completion
+}
+\description{
+completion 
+}
+\usage{
+CompletePlusWrap(...)
+}
+\arguments{
+\item{\dots}{arguments for \code{\link[svMisc]{CompletePlus}}
+}
+\value{
+A list with these items
+\item{data}{A matrix of potential completions. }
+\item{token}{The token being completed}
+\item{fun}{in case of function completion, the name of the function}
+\item{tooltip}{in case of function completion, the function tooltip}
+}
+\author{
+Romain Francois <francoisromain at free.fr>
+}
+\seealso{
+\code{\link[svMisc]{CompletePlus}}
+}
+\keyword{manip}
+

Added: pkg/svTools/man/namespaceParser.Rd
===================================================================
--- pkg/svTools/man/namespaceParser.Rd	                        (rev 0)
+++ pkg/svTools/man/namespaceParser.Rd	2009-08-06 19:36:37 UTC (rev 169)
@@ -0,0 +1,25 @@
+\name{namespaceParser}
+\Rdversion{1.1}
+\alias{namespaceParser}
+\title{
+NAMESPACE parser 
+}
+\description{
+parses a NAMESPACE file and look for errors
+}
+\usage{
+namespaceParser(NAMESPACE, checkPackages = TRUE)
+}
+\arguments{
+  \item{NAMESPACE}{name of the file}
+  \item{checkPackages}{logical; if TRUE, packages that 
+  	are set to be imported are checked to be installed}
+}
+\value{
+a data frame that contains errors in the NAMESPACE file
+}
+\author{
+Romain Francois <francoisromain at free.fr>
+}
+\keyword{manip}
+