Sets the current name format

Share:

Description

Sets the current name format. Throws a RccViolationException if an unknown format is requested.

Usage

1
2
3
4
5
6
## Static method (use this):
## Rdoc$setNameFormat(nameFormat, ...)

## Don't use the below:
## S3 method for class 'Rdoc'
setNameFormat(static, nameFormat, ...)

Arguments

nameFormat

If "method.class", help files for methods belonging to classes are named <method>.<class>. If "class.method", help files for methods belonging to classes are named <class>.<method>. These are currently the only name formats supported.

...

Not used.

Value

Returns nothing.

Author(s)

Henrik Bengtsson

See Also

*getNameFormat() For more information see Rdoc.

Want to suggest features or report bugs for rdrr.io? Use the GitHub issue tracker.