в то время как в файле NAMESPACE я просто указываю, что экспортирую класс Logger, я не указываю его методы: все они автоматически экспортируются.
не документировать использование функций-членов ссылочного класса?
если я напишуRd файл с\usage блок, как мне избежатьWARNING
Functions/methods with usage in documentation object 'XmlDoc' but not in code:
$ new
Я бы ожидал\usage блок, чтобы позволить мне писать такие вещи, как:
obj <- ClassName$new(par1, par2, ...)
obj$method1(oth1, ...)
а затем я задокументирую параметры в\arguments блок.
Если я сделаю это,R CMD check жалуется с
Assignments in \usage in documentation object 'ClassName':
и не распознает методы как объекты кода, мне нужен документ.
на данный момент я пишуRd файлы без\usage заблокировать и записать приведенный выше код в\examples блок, но тогда у меня нет места для документирования аргументов и таким образомcheck на самом деле очень мало, чтобы проверить. Поскольку меня это не устраивает, я сейчас спрашиваю сообщество о текущей общей практике.