Skip to content

Roxygen

6 messages · Peter Danenberg, Kasper Daniel Hansen, Hadley Wickham

#
Is this the appropriate place for GSoC conversations?

If I understand the proposal correctly, there should be a lexer
(written in R) that exposes an API; that API would be used by
segregated mini-parsers (Roclets) which do the dirty work of Roxygen
-> {html, LaTeX, DocBook, ...} translation.

The lexer should ship with a proof-of-concept Roclet. Have I missed
anything?
#
On Mon, Mar 17, 2008 at 11:56 PM, Peter Danenberg <pcd at wikitex.org> wrote:
You should probably also survey existing attempts - I have written
something with ruby that suggest some ideas.  I also have a number of
packages documented with that format which could be used for testing -
I'd be happy to reformat my existing documentation if it meant I would
no longer have to maintain my quick and dirty (and buggy!) parser.

Hadley
#
Fascinating, Hadley; do you have a link to the source, by any chance?

I imagine doing it in Scheme, Ruby or any language, for that matter,
where creating DSLs is cheap; would be a joy.
#
You might also want to look at the Rdoc setup in the R.oo package.  
While my 30 secs glance at Roxygen suggests that it is a more flexible  
system, Rdoc always you to keep the help inside the function source  
file.

Kasper
On Mar 19, 2008, at 8:15 AM, Peter Danenberg wrote:

            
#
On Wed, Mar 19, 2008 at 4:15 PM, Peter Danenberg <pcd at wikitex.org> wrote:
It's completely local.  I'll send you a copy off list.

Hadley
#
Hmm; Rdoc seems thorough enough. What remains to be desired?