forked from r-lib/roxygen2
-
Notifications
You must be signed in to change notification settings - Fork 0
Home
lawremi edited this page Aug 31, 2011
·
3 revisions
Welcome to the roxygen wiki!
Currently, Roxygen processes source code annotations (implemented as comments with tags) to generate documentation and a few other things (including a NAMESPACE file). Its design though is sufficiently general to support much more, probably through plugin packages. For example, one possible extended annotation would be typing of function arguments. This information could land in an IDL or be used to generate assertions, etc.
The R documentation system has lots of room for improvement. Roxygen will likely be an important component of a revised system that converts source code annotations to some common documentation data model, usually in its persistent form. See R Documentation Plans for some plans.