Я только что начал играть вокруг с roxygen
пакет и я имеем очень довольный результатами до сих пор. Однако я задавался вопросом, там способ определить к roxygen
то, что это должно проигнорировать определенные функции, которые не доступны для пользователя?
А именно, у меня не было бы a .Rd
всплывающее окно файла, потому что я использую .onLoad()
рычаг в моем пакете. Эта функция уже документируется в base
пакет, таким образом, нет никакой причины для меня повторно зарегистрировать его.
Итак, я наконец нашел и просмотрел список Roxygen-devel на R-forge , чтобы узнать, когда это будет реализовано, и, похоже, он уже есть в версии Roxygen, которая находится на CRAN. Ключ должен указать use.Rd2 = TRUE
при вызове roxygenize ()
. В этом режиме Roxygen пропустит создание документации для любых функций, которым не предшествуют комментарии Roxygen.
Это в их списке дел - в следующей версии только функции с документацией roxygen будут создавать файлы man.