R/Return.R

In Dasonk/flydoc: Provide documentation for your functions on the fly.

#' Look at flydoc return
#' 
#' Look at the the return for your flydoc documnetation
#' for a given function.  This is what drives the section
#' labeled "Value" in the help files.
#' 
#' @param fun A function
#' @aliases Value
#' @export
Return <- function(fun){
    flyget("Return", fun)
}

#' Set documentation for return
#' 
#' Set a return for your flydoc documentation for a
#' given function. This is what drive the section
#' labeled "Value" in the help files.
#' 
#' @param func A function to add a flydoc return to.
#' @param value A character string containing the 
#'  return to add to the function's documentation
#' @export
"Return<-" <- function(func, value){
    invisible(flyassign("Return", func, value))
}