Документация Roxygen для существующих дженериков

Question

Я написал show() метод для класса S4 myclass который я определил в моем пакете. Я создал документацию для класса и метода с roxygen2. Все работает хорошо, за исключением того, что я получаю следующее предупреждение в результатах проверки CMD R:

проверка отсутствующих записей документации... ВНИМАНИЕ
Недокументированные методы S4: общая длина и сиглист myclass

Как мне заняться документированием? show дженерик который я сам не написал?

Answer 1

В конце концов, используя явный @aliases а также @docType Теги решили проблему для меня. Мой блок документации теперь выглядит так:

#' Show method for objects of class \code{myclass}.
#'
#' @docType methods
#' @name show-myclass
#' @rdname show-myclass
#' @aliases show-myclass show,myclass-method
#'
#' @param x A \code{myclass} object.
#'
#' @export