svTools (version 0.9-0)

completeRoxygen: completion for R oxygen entries

Description

Proposes completions for R oxygen inline documentation of R functions.

Usage

completeRoxygen(line = "#'")
completeRoxygenParam(file, row, line = "#' @param ")

Arguments

file

a file to complete.

row

location of the cursor (row) in the file.

line

line of code currently edited.

Value

• A list with the following items:
• token
  token that is being completed.
• completions
  list of current completions.
• tooltip
  further explanation about completion items (for completeRoxygen() only).

concept

completion list for R oxygen inline code documentation

References

Roxygen. http://roxygen.org/

See Also

generateRoxygenTemplate

Examples

completeRoxygen("#'")
completeRoxygen("#' @ex")