extra.code.docs: Extract documentation from code chunks

In inlinedocs: Convert Inline Comments to Documentation

Extract documentation from code chunks

Description

Parse R code to extract inline documentation from comments around each function. These are not able to be retreived simply by looking at the "source" attribute. This is a Parser Function that can be used in the parser list of package.skeleton.dx(). TODO: Modularize this into separate Parsers Functions for S4 classes, prefixes, ##<<blocks, etc. Right now it is not very clean!

Usage

extra.code.docs(code, 
    objs, ...)

Arguments

code	Code lines in a character vector containing multiple R objects to parse for documentation.
objs	The objects defined in the code.
...	ignored

Value

named list of lists, one for each object to document.

Author(s)

Toby Dylan Hocking <[e-mail]> [aut, cre], Keith Ponting [aut], Thomas Wutzler [aut], Philippe Grosjean [aut], Markus Müller [aut], R Core Team [ctb, cph]

inlinedocs documentation built on Oct. 19, 2023, 1:06 a.m.