R/addNumbers.R

In cmatKhan/demoPackage: What the Package Does (One Line, Title Case)

#' Add two numbers together
#'
#' @param x a number
#' @param y another number
#'
#' @return the sum of \code{x} \code{y}
#'
#' @examples
#'  add(1,1)
#'  add(10,1)
#'
#' @note this example is taken from the roxygen documnetation here: https://cran.r-project.org/web/packages/roxygen2/vignettes/roxygen2.html
#'
#' @export
add = function(x, y){
  # don't use the 'ticked' comments in here!
  x + y
}