Как отображать элементы возвращенного списка в Roxygen?

Question

я могу сделать это легко с входными параметрами при наличии нескольких строк @param делая так:

#' @param var1 This is for x 
#' @param var2 This is for y 
#' @param var3 This is for Z 

Но как же вы, что для элементов списка вы возвращаете. Я хочу включать имена каждого элемента и описание их. Объединение @return или @param не имеет такого же поведения. Что такое соответствующий тег?

#' @return A list with the following elements: 
#' @something element1 Contains x 
#' @something element2 Contains y 
#' @something element3 Contains z 

Пакет samr имеет точное уценки форматирование Я ищу:

Answer 1

Из инструкции - http://roxygen.org/roxygen2-manual.pdf

@return Используется для документирования объекта, возвращаемого функцией , Для списков используйте параметр \ item {name a} {описание a}, описывающий каждый компонент списка