setNameFormat.Rdoc: Sets the current name format

In R.oo: R Object-Oriented Programming with or without References

Sets the current name format

Description

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

Usage

## 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.

R.oo documentation built on May 29, 2024, 6:41 a.m.