SCM

SCM Repository

[inlinedocs] Log of /pkg/inlinedocs/man/inlinedocs-package.Rd
[inlinedocs] / pkg / inlinedocs / man / inlinedocs-package.Rd  
ViewVC logotype

Log of /pkg/inlinedocs/man/inlinedocs-package.Rd

Parent Directory Parent Directory


Links to HEAD: (view) (download) (as text) (annotate)
Sticky Revision:

Revision 305 - (view) (download) (as text) (annotate) - [select for diffs]
Modified Tue Aug 16 11:48:38 2011 UTC (7 years, 11 months ago) by kmpont
File length: 953 byte(s)
Diff to previous 291
Added default title for setClass when no # title on setClass line

Revision 291 - (view) (download) (as text) (annotate) - [select for diffs]
Modified Tue Jun 7 08:59:30 2011 UTC (8 years, 1 month ago) by tdhock
File length: 951 byte(s)
Diff to previous 270
linebreak

Revision 270 - (view) (download) (as text) (annotate) - [select for diffs]
Modified Mon May 23 15:53:47 2011 UTC (8 years, 2 months ago) by tdhock
File length: 934 byte(s)
Diff to previous 213
delete examples.after.return support

Revision 213 - (view) (download) (as text) (annotate) - [select for diffs]
Modified Wed Mar 9 16:49:46 2011 UTC (8 years, 4 months ago) by kmpont
File length: 936 byte(s)
Diff to previous 212
Options fix just introduced now correctly restores original settings

Revision 212 - (view) (download) (as text) (annotate) - [select for diffs]
Modified Wed Mar 9 16:37:25 2011 UTC (8 years, 4 months ago) by kmpont
File length: 913 byte(s)
Diff to previous 154
Fix parser to avoid breaking when processing inlinedocs source. (Problem
was redefinition of class DocLink into inlinedocs environment, where it
already existed).

First attempt at adding sections and thoughts to JSS article

silly.example.R now includes some R.oo class and method declarations to
test that aspect; the previous "detect the first ." approach has been
erased in favour of the better method now extracted as a separate
"leadingS3generic" function.


Revision 154 - (view) (download) (as text) (annotate) - [select for diffs]
Modified Fri Oct 29 12:11:52 2010 UTC (8 years, 8 months ago) by tdhock
File length: 911 byte(s)
Diff to previous 140
parsefun and extract.docs.fun consolidated into extract.xxx.chunks in ongoing effort to make parser functions more readable and modular

Revision 140 - (view) (download) (as text) (annotate) - [select for diffs]
Modified Tue Oct 19 23:24:01 2010 UTC (8 years, 9 months ago) by tdhock
File length: 911 byte(s)
Diff to previous 125
do ex in tempdir

Revision 125 - (view) (download) (as text) (annotate) - [select for diffs]
Modified Thu Sep 16 09:34:38 2010 UTC (8 years, 10 months ago) by tdhock
File length: 911 byte(s)
Diff to previous 123
extended package.skeleton.dx example that also checks the silly package and verifies that there are no warnings

Revision 123 - (view) (download) (as text) (annotate) - [select for diffs]
Modified Mon Aug 30 09:19:39 2010 UTC (8 years, 10 months ago) by tomaschwutz
File length: 455 byte(s)
Diff to previous 122
added alias inlinedocs to function package.skeleton.dx (to be displayed on ?inlinedocs)
added an example to package.skeleton.dx
added the silly package to inst directory, so that a package for examples is available at installation time 


Revision 122 - (view) (download) (as text) (annotate) - [select for diffs]
Modified Sat Aug 28 21:36:48 2010 UTC (8 years, 10 months ago) by tomaschwutz
File length: 934 byte(s)
Diff to previous 109
implemented Claudia's suggestion about the assignment function of example code to attribute ex:
added function inlinedocExample<- in file package.skeleton.dx.R with specifying the example already using this mechanism
added testfile attrExamples.R

in addition added suppressWarnings() around the call to package.skeleton, because it always gave a warning of non-exisiting package with my Windows version of R 10.1.

Revision 109 - (view) (download) (as text) (annotate) - [select for diffs]
Modified Mon Jun 7 08:42:15 2010 UTC (9 years, 1 month ago) by tdhock
File length: 911 byte(s)
Diff to previous 90
extract.docs.file new functionality parses files independently

Revision 90 - (view) (download) (as text) (annotate) - [select for diffs]
Modified Mon May 3 14:03:10 2010 UTC (9 years, 2 months ago) by tdhock
File length: 916 byte(s)
Diff to previous 84
unix line endings

Revision 84 - (view) (download) (as text) (annotate) - [select for diffs]
Modified Thu Apr 22 10:11:18 2010 UTC (9 years, 3 months ago) by kmpont
File length: 939 byte(s)
Diff to previous 75
Further fixes for S3 methods declared with setMethodS3

1) automatically generates \method{}{} markup which should be correct if
and only if the generic name is everything up to but not including the
first period in the function name. Thus this will not work properly if a
generic function has a name like "my.generic" so that the specific function
is "my.generic.my_type".

2) fix for behaviour of package.skeleton, which, as used within this
package, for a function "[[.Distribution" generates a file with name
"z[[.Distribution.Rd"

3) prints S3method calls suitable for inclusion in a NAMESPACE file

The mechanism depends on the parse of the source file picking up and
setting the "created" field to "setMethodS3". Something similar might work
for other ways of creating S3 generics, but I am not currently clear how to
pick those up reliably.

Revision 75 - (view) (download) (as text) (annotate) - [select for diffs]
Modified Mon Apr 12 09:30:28 2010 UTC (9 years, 3 months ago) by tdhock
File length: 916 byte(s)
Diff to previous 70
docs update, passes r cmd check, upload to cran

Revision 70 - (view) (download) (as text) (annotate) - [select for diffs]
Modified Fri Jan 15 09:42:36 2010 UTC (9 years, 6 months ago) by kmpont
File length: 977 byte(s)
Diff to previous 62
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.

Revision 62 - (view) (download) (as text) (annotate) - [select for diffs]
Modified Tue Dec 8 15:00:47 2009 UTC (9 years, 7 months ago) by tdhock
File length: 927 byte(s)
Diff to previous 60
update email address, add new extract pages

Revision 60 - (view) (download) (as text) (annotate) - [select for diffs]
Modified Mon Nov 30 18:05:13 2009 UTC (9 years, 7 months ago) by kmpont
File length: 957 byte(s)
Diff to previous 57
First implementation of docs within S4 class definitions

Revision 57 - (view) (download) (as text) (annotate) - [select for diffs]
Modified Mon Nov 23 16:46:00 2009 UTC (9 years, 8 months ago) by kmpont
File length: 974 byte(s)
Diff to previous 52
Initial implementation of 'extra' fields information via ##field<<

Revision 52 - (view) (download) (as text) (annotate) - [select for diffs]
Modified Wed Nov 11 22:26:18 2009 UTC (9 years, 8 months ago) by tdhock
File length: 1172 byte(s)
Diff to previous 51
remove Rdversion lines, R-2.10

Revision 51 - (view) (download) (as text) (annotate) - [select for diffs]
Modified Wed Nov 11 15:38:23 2009 UTC (9 years, 8 months ago) by tdhock
File length: 1188 byte(s)
Diff to previous 38
update desc with keith as coauthor

Revision 38 - (view) (download) (as text) (annotate) - [select for diffs]
Modified Mon Sep 21 16:54:38 2009 UTC (9 years, 10 months ago) by tdhock
File length: 1099 byte(s)
Diff to previous 28
desc and docs update

Revision 28 - (view) (download) (as text) (annotate) - [select for diffs]
Modified Wed Aug 5 10:07:40 2009 UTC (9 years, 11 months ago) by tdhock
File length: 919 byte(s)
Diff to previous 18
extract -package info from DESCRIPTION file

Revision 18 - (view) (download) (as text) (annotate) - [select for diffs]
Modified Sat Aug 1 22:01:23 2009 UTC (9 years, 11 months ago) by tdhock
File length: 516 byte(s)
Diff to previous 8
error checking and automatic DESCRIPTION added

Revision 8 - (view) (download) (as text) (annotate) - [select for diffs]
Modified Fri Jul 31 17:13:17 2009 UTC (9 years, 11 months ago) by tdhock
File length: 471 byte(s)
Diff to previous 7
dots argument special case, package name alias conflict special case

Revision 7 - (view) (download) (as text) (annotate) - [select for diffs]
Modified Fri Jul 31 15:11:15 2009 UTC (9 years, 11 months ago) by tdhock
File length: 490 byte(s)
Diff to previous 5
works with new find/replace mechanism

Revision 5 - (view) (download) (as text) (annotate) - [select for diffs]
Modified Fri Jul 31 09:56:58 2009 UTC (9 years, 11 months ago) by tdhock
File length: 908 byte(s)
Diff to previous 3
author tag, switch statement, more comments

Revision 3 - (view) (download) (as text) (annotate) - [select for diffs]
Added Thu Jul 30 09:43:37 2009 UTC (9 years, 11 months ago) by tdhock
File length: 908 byte(s)
support for comments about function return values, resulting documentation passes R CMD check with no warnings

This form allows you to request diffs between any two revisions of this file. For each of the two "sides" of the diff, enter a numeric revision.

  Diffs between and
  Type of Diff should be a

Sort log by:

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