inlinedocs (version 2013.9.3)

extract.docs.fun: 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).

Details

For simple functions/arguments, the argument may also be documented by appending ##<< comments on the same line as the argument. For those who wish to become confused, any following ### comment lines will be appended.

Additionally, contiguous sections of ## comment lines beginning with <

In the case of value, the extra information is appended to that from any final ### comment lines.

Each separate extra section appears as a new paragraph except that empty sections (no matter how many lines) are ignored.