extract.docs.file {inlinedocs}R Documentation

Extract documentation from a file

Description

Parse an R code file and extract inline documentation from comments around each function.

Usage

extract.docs.file(code.file, write.examples = TRUE)

Arguments

code.file The R code file to parse.
write.examples Gather examples from test files?

Value

named list of lists. Each element is the result of a call to extract.docs.fun, with names corresponding to functions found in the R code file.

Author(s)

Toby Dylan Hocking <toby.hocking@etu.upmc.fr>


[Package inlinedocs version 1.0 Index]