From bdd1ec3cd6aacaf46d76dc5f430cbdbd9a6762e8 Mon Sep 17 00:00:00 2001
From: teramonagi <teramonagi@gmail.com>
Date: Sat, 12 Mar 2016 19:36:38 +0900
Subject: [PATCH] Fixed roxygen comments

---
 R/ODBCConnection.R                     | 6 ++++--
 R/ODBCDriver.R                         | 1 +
 R/ODBCResult.R                         | 1 +
 man/dbConnect-ODBCDriver-method.Rd     | 2 ++
 man/dbGetInfo-ODBCConnection-method.Rd | 2 ++
 man/odbc-meta.Rd                       | 3 +++
 man/odbc-query.Rd                      | 6 ++++--
 7 files changed, 17 insertions(+), 4 deletions(-)

diff --git a/R/ODBCConnection.R b/R/ODBCConnection.R
index 304171e..2bedeb4 100644
--- a/R/ODBCConnection.R
+++ b/R/ODBCConnection.R
@@ -20,8 +20,9 @@ setClass(
 #' fetches and clears for you.
 #' 
 #' @param conn An existing \code{\linkS4class{ODBCConnection}}
-#' @param res  An existing \code{\linkS4class{ODBCResult}}
-#' @param n The number of the record you want to extract. -1 means "all"
+#' @param statement  The SQL which you want to run
+#' @param res An object of class \code{\linkS4class{ODBCResult}}
+#' @param n Number of rows to return. If less than zero returns all rows.
 #' @param ... Other parameters passed on to methods
 #' @export
 #' @rdname odbc-query
@@ -35,6 +36,7 @@ setMethod("dbSendQuery", "ODBCConnection", function(conn, statement, ...) {
 #' Get DBMS metadata.
 #' 
 #' @param dbObj An object inheriting from \code{\linkS4class{ODBCConnection}}, \code{\linkS4class{ODBCDriver}}, or a \code{\linkS4class{ODBCResult}}
+#' @param ... Other parameters passed on to methods
 #' @export
 setMethod("dbGetInfo", "ODBCConnection", function(dbObj, ...) {
   info <- RODBC::odbcGetInfo(dbObj@odbc)
diff --git a/R/ODBCDriver.R b/R/ODBCDriver.R
index 60684e4..53615f5 100644
--- a/R/ODBCDriver.R
+++ b/R/ODBCDriver.R
@@ -38,6 +38,7 @@ setMethod("dbUnloadDriver", "ODBCDriver", function(drv, ...) {TRUE})
 #' @param dsn Data source name you defined by ODBC data source administrator tool.
 #' @param user User name to connect as.
 #' @param password Password to be used if the DSN demands password authentication.
+#' @param ... Other parameters passed on to methods
 #' @export
 #' @examples
 #' \dontrun{
diff --git a/R/ODBCResult.R b/R/ODBCResult.R
index 81ac5d1..9746e15 100644
--- a/R/ODBCResult.R
+++ b/R/ODBCResult.R
@@ -104,6 +104,7 @@ setMethod("dbGetInfo", "ODBCResult", function(dbObj, ...) {
 })
 
 
+#' @rdname odbc-meta
 #' @export
 setMethod("dbColumnInfo", "ODBCResult", function(res, ...) {
   df <- sqlQuery(res@connection@odbc, res@sql, max=1)
diff --git a/man/dbConnect-ODBCDriver-method.Rd b/man/dbConnect-ODBCDriver-method.Rd
index 4b51851..99d0598 100755
--- a/man/dbConnect-ODBCDriver-method.Rd
+++ b/man/dbConnect-ODBCDriver-method.Rd
@@ -16,6 +16,8 @@
 \item{user}{User name to connect as.}
 
 \item{password}{Password to be used if the DSN demands password authentication.}
+
+\item{...}{Other parameters passed on to methods}
 }
 \description{
 These methods are straight-forward implementations of the corresponding generic functions.
diff --git a/man/dbGetInfo-ODBCConnection-method.Rd b/man/dbGetInfo-ODBCConnection-method.Rd
index 67921a9..b45ff76 100755
--- a/man/dbGetInfo-ODBCConnection-method.Rd
+++ b/man/dbGetInfo-ODBCConnection-method.Rd
@@ -9,6 +9,8 @@
 }
 \arguments{
 \item{dbObj}{An object inheriting from \code{\linkS4class{ODBCConnection}}, \code{\linkS4class{ODBCDriver}}, or a \code{\linkS4class{ODBCResult}}}
+
+\item{...}{Other parameters passed on to methods}
 }
 \description{
 Get DBMS metadata.
diff --git a/man/odbc-meta.Rd b/man/odbc-meta.Rd
index 3dac658..c60302b 100644
--- a/man/odbc-meta.Rd
+++ b/man/odbc-meta.Rd
@@ -2,6 +2,7 @@
 % Please edit documentation in R/ODBCResult.R
 \docType{methods}
 \name{odbc-meta}
+\alias{dbColumnInfo,ODBCResult-method}
 \alias{dbGetInfo,ODBCResult-method}
 \alias{dbGetRowCount,ODBCResult-method}
 \alias{dbGetStatement,ODBCResult-method}
@@ -13,6 +14,8 @@
 \S4method{dbGetStatement}{ODBCResult}(res, ...)
 
 \S4method{dbGetInfo}{ODBCResult}(dbObj, ...)
+
+\S4method{dbColumnInfo}{ODBCResult}(res, ...)
 }
 \arguments{
 \item{res}{An object of class \code{\linkS4class{ODBCResult}}}
diff --git a/man/odbc-query.Rd b/man/odbc-query.Rd
index a0363f4..ce7541c 100644
--- a/man/odbc-query.Rd
+++ b/man/odbc-query.Rd
@@ -19,11 +19,13 @@
 \arguments{
 \item{conn}{An existing \code{\linkS4class{ODBCConnection}}}
 
+\item{statement}{The SQL which you want to run}
+
 \item{...}{Other parameters passed on to methods}
 
-\item{res}{An existing \code{\linkS4class{ODBCResult}}}
+\item{res}{An object of class \code{\linkS4class{ODBCResult}}}
 
-\item{n}{The number of the record you want to extract. -1 means "all"}
+\item{n}{Number of rows to return. If less than zero returns all rows.}
 }
 \description{
 To retrieve results a chunk at a time, use \code{dbSendQuery},