S4 mehtod inline documentation

Share:

Description

Using the same conventions as for functions, definitions of S4 methods in the form setMethod(...) are also located and scanned for inline comments.

Usage

1
2
extract.docs.setMethod(doc.link, env, inlinedocs.exampleDir, 
    inlinedocs.exampleTrunk)

Arguments

doc.link

DocLink object as created by extract.file.parse.

env

environment to find method source

inlinedocs.exampleDir

A string pointing to the location where inlinedocs should search for external examples

inlinedocs.exampleTrunk

A regular expression used to identify the files containing external examples in the example directory

Author(s)

Toby Dylan Hocking <toby@sg.cs.titech.ac.jp> [aut, cre], Keith Ponting [aut], Thomas Wutzler [aut], Philippe Grosjean [aut], Markus Müller [aut], R Core Team [ctb, cph]

Want to suggest features or report bugs for rdrr.io? Use the GitHub issue tracker.