R/add.R

In liuyishen418/mypkg:

#' Add together two numbers
#'
#' This is more detailed description.
#'
#' this is again another level of detail.
#'
#' @param x A number
#' @param y A number
#' @return The sum of \code{x} and \code{y}.
#' @examples
#' add(1, 1)
#' add(10, 1)
#' \dontrun{
#' add(a, b)
#' }
#' @section Warning:
#' Do not use strings as input for \code{x} or \code{y}
#' .
#' @family add hello
#' @seealso \code{\link{prod}} for products. Or in this link \url{http://en.wikipedia.org/wiki/Integer_overflow}.
#' @export

add <- function(x, y) {
  x + y
}