parseFunction: parseFunctionParse annotated comments of a function...

Usage Arguments Value Examples

View source: R/parseFunction.R

Usage

1
    parseFunction(cmts, p, pd, fp, rp)

Arguments

cmts

lines with comments

p

general annotation pattern

pd

descritption pattern

fp

function pattern

rp

return value pattern

Value

Returns a 'FunctionDoc'

Examples

1
2
3
4
5
##---- Should be DIRECTLY executable !! ----
##-- ==>  Define data, use random,
##--	or do  help(data=index)  for the standard data sets.

## The function is currently defined as

michelk/annotSrcDoc.R documentation built on May 22, 2017, 6:51 a.m.