我正在print()
通过一种方法扩展功能print.dmdSchemeSet()
。这个函数有额外的参数,我显然已经使用 roxygen2 在源文件中记录了这些参数:
#' Generic print function for \code{dmdSchemeSet}
#'
#' @param x object of type \code{dmdSchemeSet}
#' @param ... additional arguments - not used here
#' @param printAttr default \code{TRUE} - attributes are printed
#' @param printExtAttr default \code{FALSE} - additional attributes are not printed (e.g. \code{class})
#' @param printData default \code{TRUE} - data is printed
#' @param .prefix mainly for internal use - prefix for all printed lines
#'
#' @return invisibly x
#' @export
#'
print.dmdSchemeSet <- function(x, ..., printAttr = TRUE, printExtAttr = FALSE, printData = TRUE, .prefix = ""){
...
}
现在该函数仅作为通用函数导出,这很好,并且可以正常工作。
但是用户如何查看这些函数的文档呢?
我可以以这样一种方式制作文档,以便用户可以直观地找到它吗?