R/docr_param.R

Defines functions docr.param

Documented in docr.param

#' Generate preformatted param roxygen lines from a function name.
#'
#'
#' \code{docr.param}
#'
#'
#'
#' @family Documentation functions
#' @export
docr.param <- function(fun_name = NULL){

  all_argz <- formalArgs(fun_name)

  prep_d <- sprintf("@param %s", all_argz)

  prep_d
}
CarlBoneri/roxydoc2 documentation built on Nov. 6, 2019, 8:01 a.m.