[inlinedocs] tabs before comments and symbols, S3 methods

Thomas Wutzler twutz at bgc-jena.mpg.de
Fri Apr 30 14:44:44 CEST 2010


Dear Keith,

thanks to you for implementing the setMethodS3 support.

I tried to understand how it is applied and added a test project sillyS3
to the test directory, which discussion can be based upon.

In the code of extract.file.parse you comment
      ##details<< The \code{setMethodS3} calls introduce additional
      ## complexity: they will define an additional S3 generic (which
      ## needs documentation to avoid warnings at package build time)
      ## unless one already exists. This also is handled by "linking"
      ## documentation. A previously unseen generic is linked to the
      ## first defining instances, subsequent definitions of that gen.
      ## also link back to the first defining instance.

I do not quite understand.
What is an "linking documentation", "unseen generic", and what an "first
defining instance"?

In the sillyS3 toy example, I see that the parse result includes an
entry for the generic function. However, it does not (yet?) effect the
generated documentation. Hence R CMD check complains about an
undocumented function.

I would be glad about some guidance.

Best regards
Thomas









More information about the Inlinedocs-support mailing list