Search code examples
rdocumentationroxygen

When documenting in Roxygen: How do I make an itemized list in @details?

What is the appropriate syntax to add an itemized list to roxygen2, for instance, in the @details section? Can I create a latex list environment?

It seems that line breaks are simply ignored, i.e. 

#' @details text describing parameter inputs in more detail
#'
#' parameter 1: stuff
#' 
#' parameter 2: stuff

thanks!

Solution

  • Here is a roxygen2 example following your problem formulation.

    ##'
##' @details text describing parameter inputs in more detail.
##' \itemize{
##'  \item{"parameter 1"}{Stuff}
##'  \item{"parameter 2"}{Stuff}
##' }
##'

    This will allow you to use itemize in details section. You can also use it in the @param sections.

    Hope this helps.