diff --git a/R/package-roclang.R b/R/package-roclang.R index ab457c5..e5c3b3a 100644 --- a/R/package-roclang.R +++ b/R/package-roclang.R @@ -8,7 +8,13 @@ #' * Text extraction and manipulation function: \code{\link{extract_roc_text}}. #' * Rd evaluation and compilation function: \code{\link{roc_eval_text}}. #' +#' @note Change log: +#' \itemize{ +#' \item{0.1.1 Xiurui Zhu - Initiate the document.} +#' } +#' @author Xiurui Zhu +#' #' @docType package -#' @name roclang -#' @aliases roclang-package +#' @name roclang-package +#' @aliases roclang NULL diff --git a/man/roclang.Rd b/man/roclang-package.Rd similarity index 85% rename from man/roclang.Rd rename to man/roclang-package.Rd index 71ce4d9..7cdca0c 100644 --- a/man/roclang.Rd +++ b/man/roclang-package.Rd @@ -1,15 +1,21 @@ % Generated by roxygen2: do not edit by hand % Please edit documentation in R/package-roclang.R \docType{package} -\name{roclang} -\alias{roclang} +\name{roclang-package} \alias{roclang-package} +\alias{roclang} \title{roclang: A package for diffusing function documentations into 'roxygen' comments} \description{ The 'roclang' package facilitates efficient diffusing of content across function documentations. Sections, parameters or dot parameters are extracted from function documentations and turned into valid Rd character strings, which are ready to diffuse into the 'roxygen' comments of another function by inserting inline code. } +\note{ +Change log: +\itemize{ +\item{0.1.1 Xiurui Zhu - Initiate the document.} +} +} \section{Functions}{ \itemize{ @@ -18,3 +24,6 @@ which are ready to diffuse into the 'roxygen' comments of another function by in } } +\author{ +Xiurui Zhu +}