This function is a wrapper for the roxygen2::roxygenize() function from the roxygen2 package. See the documentation and vignettes of that package to learn how to use roxygen.

document(pkg = ".", roclets = NULL, quiet = FALSE)

## Arguments

pkg The package to use, can be a file path to the package or a package object. See as.package() for more information. Character vector of roclet names to use with package. The default, NULL, uses the roxygen roclets option, which defaults to c("collate", "namespace", "rd"). if TRUE suppresses output from this function.

roxygen2::roxygenize(), browseVignettes("roxygen2")