SCM

SCM Repository

[inlinedocs] Revision 70
ViewVC logotype

Revision 70


Jump to revision: Previous Next
Author: kmpont
Date: Fri Jan 15 09:42:36 2010 UTC (9 years, 5 months ago)
Log Message:
Completed experimental implementation for S3 classes using R.oo.

1) Search for comments preceding definition now uses parse on file
   insteadof grep via new method extract.file.parse. This works for more
   ways of defining values and does not require blank lines after
   definitions.

2) When an S3 generic is defined using setMethodS3:
a) the generic is documented with a copy of the inline documentation for the
   specific.
b) (Very experimental!) further definitions of the same generic inherit
   documentation from the first version defined in the same source file.
   The idea is to avoid repeating documentation when defining the generic
   repeatedly for an inheritance hierarchy.
   Thus if an argument is not documented, the documentation from the first
   version of the generic will be used. At present this applies to _all_
   documentation entries, but that may be reduced in the future.

3) Further minor tweaks:
a) fixes to work around package.skeleton issue: if a default argument
   contains a "%" character, then it should be escaped in the skeleton
   \usage, but is not, causing things to break nastily.
b) If documentation for an object contains an explicit title but no
   description, then the title is copied into the description in order
   to avoid warnings from the package checking process which requires
   description to be present. The idea here is to simplify generating
   documentation for small methods by reducing it to the bare minimum.

Changed paths:

Path Details
Directorypkg/inlinedocs/DESCRIPTION modified , text changed
Directorypkg/inlinedocs/R/package.skeleton.dx.R modified , text changed
Directorypkg/inlinedocs/man/decomment.Rd modified , text changed
Directorypkg/inlinedocs/man/empty.description.Rd modified , text changed
Directorypkg/inlinedocs/man/extract.docs.chunk.Rd modified , text changed
Directorypkg/inlinedocs/man/extract.docs.file.Rd modified , text changed
Directorypkg/inlinedocs/man/extract.docs.fun.Rd modified , text changed
Directorypkg/inlinedocs/man/extract.docs.setClass.Rd modified , text changed
Directorypkg/inlinedocs/man/extract.file.parse.Rd added
Directorypkg/inlinedocs/man/fields.Rd modified , text changed
Directorypkg/inlinedocs/man/inlinedocs-package.Rd modified , text changed
Directorypkg/inlinedocs/man/modify.Rd.file.Rd modified , text changed
Directorypkg/inlinedocs/man/package.skeleton.dx.Rd modified , text changed
Directorypkg/inlinedocs/man/prefix.Rd modified , text changed
Directorypkg/inlinedocs/tests/unit.tests.Rout.save modified , text changed

root@r-forge.r-project.org
ViewVC Help
Powered by ViewVC 1.0.0  
Thanks to:
Vienna University of Economics and Business Powered By FusionForge