parse_usage_text {Rdpack}R Documentation

Parse usage text

Description

Parse usage text.

Usage

parse_1usage_text(text)
parse_usage_text(text)

Arguments

text

content of the usage section of an Rd object, a character vector.

Details

parse_usage_text does some preprocessing of text then calls parse_1usage_text for each usage statement.

The preprocessing changes "\dots" to "..." and converts S3 method descriptions to a form suitable for parse(). The text is then parsed (with parse) and "srcref" attribute removed from the parsed object.

todo: currently no checks is made for Rd comments in text.

Value

a list containing one element for each usage entry, as prepared by parse_1usage_text

Author(s)

Georgi N. Boshnakov


[Package Rdpack version 0.10-1 Index]