R/AllClasses.R

In michelk/annotSrcDoc.R: Minimal documentation out of annotated function source code

setClass(
    "FunctionDoc",                # ^ Function documentation
    representation(
         name     = "character"     # ^ name of the function
        ,title    = "character"     # ^ title
        ,desc     = "character"     # ^ description
        ,args     = "list"          # ^ named list with argument description
        ,result   = "character"     # ^ return-value
        )
    )