yihui / Rd2roxygen

Convert Rd to roxygen documentation
https://yihui.org/Rd2roxygen
32 stars 14 forks source link

@export functions #10

Closed geophtwombly closed 11 years ago

geophtwombly commented 11 years ago

I see from package?Rd2roxygen that the documentation says

currently '@export' is not included in the comments

It would be great to be able to parse a NAMESPACE file to update the @exports, @method, @S3methods, etc

Following a question that I asked on Stack Overflow, I at least got as far as replacing ##' @return something with ##' @exports\n##'@ return something using code available as a gist. I doubt that the code is mature enough to insert into the package at present, but perhaps it is a start.

yihui commented 11 years ago

I do not think it has to be 100% mature. This package is intended to save a large portion of labor work, but certainly cannot save all. Normally there has to be a little bit labor work afterwards. So I think it will be nice to incorporate your code into this package. If you want, you can fork the repository, add your code to the end of Rd2roxygen(), and send pull requests to me. Thanks!

yihui commented 11 years ago

Just FYI, @export is supported in Rd2roxygen 1.2 now. Not ideal, but should save you some work.