R: prefixed lines

prefixed.lines {inlinedocs} | R Documentation

## prefixed lines

### Description

The primary mechanism of inline documentation is via consecutive groups of lines matching the specified prefix regular expression "`^###` " (i.e. lines beginning with "`###` ") are collected as follows into documentation sections:

description

  group starting at line 2 in the code

arguments

  group following each function argument

value

  group ending at the penultimate line of the code

These may be added to by use of the `##<<` constructs described below.

### Usage

    prefixed.lines(src, ...)

### Arguments

`src` |
`...` |

### Author(s)

Toby Dylan Hocking <toby@sg.cs.titech.ac.jp> [aut, cre], Keith Ponting [aut], Thomas Wutzler [aut], Philippe Grosjean [aut], Markus Müller [aut], R Core Team [ctb, cph]

### Examples

    test <- function
    ### the description
    (x,
    ### the first argument
     y ##<< another argument
     ){
      5
    ### the return value
    ##seealso<< foobar
    }
    src <- getSource(test)
    prefixed.lines(src)
    extract.xxx.chunks(src)

[Package inlinedocs version 2013.9.3 Index]