Skip to content

Commit

Permalink
Fix documentation for close class methods
Browse files Browse the repository at this point in the history
  • Loading branch information
caiohamamura committed Oct 27, 2023
1 parent 035cad7 commit 4aa5d9b
Show file tree
Hide file tree
Showing 4 changed files with 57 additions and 15 deletions.
30 changes: 23 additions & 7 deletions R/class.gedi.R
Original file line number Diff line number Diff line change
Expand Up @@ -154,23 +154,39 @@ h5closeall <- function(con, ...) {
}


#' Close hdf5 connections from gedi* objects
#' Safely closes the [`rGEDI::gedi.level1b-class`]
#'
#' @description
#' Closing files will avoid locking HDF5 GEDI files.
#'
#' @param con An object of class `gedi.level*`
#' @param con An object of class `gedi.level1b`
#' @param ... Inherited from base
#'
#'
#' @export
#' @rdname close
#' @method close gedi.level1b
#' Handles the [`rGEDI::gedi.level1b-class`].
#' @rdname close
setMethod("close", signature = c("gedi.level1b"), h5closeall)
#' Handles the [`rGEDI::gedi.level2a-class`].


#' Safely closes the [`rGEDI::gedi.level2a-class`]
#'
#' @description
#' Closing files will avoid locking HDF5 GEDI files.
#'
#' @param con An object of class `gedi.level2a`
#' @param ... Inherited from base
#' @method close gedi.level2a
#' @rdname close
setMethod("close", signature = c("gedi.level2a"), h5closeall)
#' Handles the [`rGEDI::gedi.level2b-class`].


#' Safely closes the [`rGEDI::gedi.level2b-class`]
#'
#' @description
#' Closing files will avoid locking HDF5 GEDI files.
#'
#' @param con An object of class `gedi.level2b`
#' @param ... Inherited from base
#' @method close gedi.level2b
#' @rdname close
setMethod("close", signature = c("gedi.level2b"), h5closeall)
16 changes: 16 additions & 0 deletions man/close-gedi.level2a-method.Rd

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

16 changes: 16 additions & 0 deletions man/close-gedi.level2b-method.Rd

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

10 changes: 2 additions & 8 deletions man/close.Rd

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

0 comments on commit 4aa5d9b

Please sign in to comment.