The roxygen documentation below,
#' Custom Assignment
#'
#' My assignment operator.
#'
#' @param x A name.
#' @param value A value to assign.
#'
#' @export
`%<-%` <- function(x, value) {
value
}
, produces the following .rd file,
\name{\%<-\%}
\alias{\%<-\%}
\title{Custom Assignment}
\usage{
\%\%(x) <- value
}
\arguments{
\item{x}{A name.}
\item{value}{A value to assign.}
}
\description{
My assignment operator.
}
The usage section should read,
The roxygen documentation below,
, produces the following .rd file,
The usage section should read,