From k.ponting at aurix.com Fri Jan 15 10:44:01 2010 From: k.ponting at aurix.com (Keith Ponting) Date: Fri, 15 Jan 2010 04:44:01 -0500 Subject: [Inlinedocs-commits] Revision 70 Message-ID: <0368DB7855FE094FBFF313BE6BC5A81001ACE562@BE02.exg3.exghost.com> 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. Keith Ponting Aurix Ltd, Malvern WR14 3SZ UK -------------- next part -------------- An HTML attachment was scrubbed... URL: http://lists.r-forge.r-project.org/pipermail/inlinedocs-commits/attachments/20100115/cabfe05a/attachment.htm