Skip to content

Commit

Permalink
Fixed roxygen comments
Browse files Browse the repository at this point in the history
  • Loading branch information
teramonagi committed Mar 12, 2016
1 parent f080ddf commit bdd1ec3
Show file tree
Hide file tree
Showing 7 changed files with 17 additions and 4 deletions.
6 changes: 4 additions & 2 deletions R/ODBCConnection.R
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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)
Expand Down
1 change: 1 addition & 0 deletions R/ODBCDriver.R
Original file line number Diff line number Diff line change
Expand Up @@ -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{
Expand Down
1 change: 1 addition & 0 deletions R/ODBCResult.R
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 2 additions & 0 deletions man/dbConnect-ODBCDriver-method.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions man/dbGetInfo-ODBCConnection-method.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions man/odbc-meta.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 4 additions & 2 deletions man/odbc-query.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit bdd1ec3

Please sign in to comment.