README.md

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

Minimal documentation out of annotated function source code

If you annotate your functions likewise

myFun <-
    function  # ^ Compute something
### ^ Optional multi-line
### ^ description
(
   x      # ^ argument x is something; which
          # ^ could possibly multi-line
  ,y =    # ^ argument y is another something
      'someDefault'
)
{
    doSomething(x,y)
}    # ^ Returns this

You could the run the executable, exec/annotatedR2doc, on the source-file

annotatedR2doc --man ../man myFun.R

I will then produce a minimal documentation-file in the man dir.

Done

• Annotated functions

ToDo

• Allow multiple functions in one file
• Annotated classes
• Annotated methods

• Allow pre annotation syntax eg

  | This functions does this

  doThis <- function ....

michelk/annotSrcDoc.R documentation built on May 22, 2019, 9:55 p.m.