[Roxygen-devel] S4 documentation

[meik michalke]

hi hadley,

Am Dienstag 25 Oktober 2011, 14:16:15 schrieb Hadley Wickham:
> Starting to look into improving roxygen2's S4 support.  Does any one
> have a good set of test cases?  (e.g. simple package that uses S4 and
> has good documentation).

have a look at
 o http://reaktanz.de/?c=hacking&s=XiMpLe
for a very small package with two S4 classes ("XiMpLe.doc-class.R" and 
"XiMpLe.node-class.R") and some methods ("node.R", "show.XiMpLe.doc.R", 
"show.XiMpLe.node.R"), or
 o http://reaktanz.de/?c=hacking&s=koRpus
for a more complex one (look for "*-class.R").

both packages are plain R code with very few dependencies. note that since 
roxygen2 didn't support "@slot" yet, i've turned off most of the roxygen 
comments (s/#'/#/) in the class files and added "@noRd", after i generated the 
docs with roxygen1. so to test you'd need to reactivate them first.


viele grüße :: m.eik

-- 
dipl. psych. meik michalke
institut f"ur experimentelle psychologie
abt. f"ur diagnostik und differentielle psychologie
heinrich-heine-universit"at d-40204 d"usseldorf
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 198 bytes
Desc: This is a digitally signed message part.
URL: <http://lists.r-forge.r-project.org/pipermail/roxygen-devel/attachments/20111025/e1b513a6/attachment.pgp>