extract.docs.fun {inlinedocs}R Documentation

Extract documentation from a function

Description

Given a function, return a list describing inline documentation in the source of that function (relies on source attr).

Usage

extract.docs.fun(fun)

Arguments

fun The function to examine.

Value

Named list of character strings extracted from comments. For each name N we will look for N{...} in the Rd file and replace it with the string in this list (implemented in modify.Rd.file).

Author(s)

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


[Package inlinedocs version 1.0 Index]