Extract or Replace Function Comments

DESCRIPTION:

Extracts or replaces the vector of character strings made up from any leading comments in the definition of the function. These come from comments preceding the function line in the corresponding source file, or from comments between the function(arglist) portion of the source and a following braced list of subexpressions.

All leading # characters and following white space are deleted in forming the character strings.

Used in creating the "Description" section of self-documentation.

USAGE:

functionComments ( object )

REQUIRED ARGUMENTS:

object
Any S-PLUS function.

VALUE:

Character vector of function comments, one comment line per character string.

EXAMPLES:

functionComments(setMethod)