Index

Type the index terms you want to search for in the text input field.
Matching terms will be shown incrementally as you type.
Press Enter to navigate to the target of the first displayed index entry.
Alternatively, Tab to move to the index entry of interest and then press Enter to navigate to that documentation page.
To jump to this page from any other documentation page, press browser-specific shortcut modifiers with i. For example, on IE and Edge this would be Alt-i while on Firefox and Chrome Alt-Shift-i. Other browsers and platforms may differ.

&
```
OBJECT & 
```
Method to test & escaping in HTML
::ruff::sample::FunnyMethods
*
```
OBJECT * 
```
Method to test regexp special chars
::ruff::sample::FunnyMethods
+
```
OBJECT + 
```
Method to test regexp special chars
::ruff::sample::FunnyMethods
<
```
OBJECT < 
```
Method to test < escaping in HTML
::ruff::sample::FunnyMethods
<tag>
```
OBJECT <tag> 
```
An explicitly exported method looking like a html tag
::ruff::sample::Base
>
```
OBJECT > 
```
Method to test > escaping in HTML
::ruff::sample::FunnyMethods
_
```
OBJECT _ 
```
Method to test underscores
::ruff::sample::FunnyMethods
added_method
```
OBJECT added_method 
```
Method defined only in Derived.
::ruff::sample::Derived
amethod
```
OBJECT amethod 
```
A method of a class created from a metaclass
::ruff::sample::MetaClassInstance
Base ::ruff::sample
base_method
```
OBJECT base_method arga argb
```
base_method is defined only in the base class
::ruff::sample::Base
character_at
```
character_at text ?pos?
```
Get the character from a string.
::ruff::sample
ConfigurableClass ::ruff::sample
constructor
```
Base create OBJNAME arg
Base new arg
```
Constructs the class
::ruff::sample::Base
constructor
```
ConfigurableClass create OBJNAME 
ConfigurableClass new 
```
A class with properties
::ruff::sample::ConfigurableClass
constructor
```
FunnyMethods create OBJNAME 
FunnyMethods new 
```
Class for testing special characters in method names
::ruff::sample::FunnyMethods
Derived ::ruff::sample
destructor
```
OBJECT destroy 
```
Releases all resources and destroys the class
::ruff::sample::Base
document
```
document namespaces ?args?
```
Generates documentation for commands and classes.
::ruff
ensemble_proc
```
ensemble_proc subcommand ...
```
A command ensemble.
::ruff::sample
ensemble_proc cmdA
```
ensemble_proc cmdA 
```
Implements cmdA for an ensemble procedure
::ruff::sample
ensemble_proc cmdB
```
ensemble_proc cmdB paramA paramB
ensemble_proc cmdB paramX
```
Implements cmdB for an ensemble procedure
::ruff::sample
formatters
```
formatters 
```
Gets the available output formatters.
::ruff
FunnyMethods ::ruff::sample
fwd_method ::ruff::sample::Base
log_error
```
log_error msg
```
Stub function to log Ruff! errors.
::ruff::app
MetaClass ::ruff::sample
MetaClassInstance ::ruff::sample
mixed_in_method
```
OBJECT mixed_in_method arg
```
This method will be mixed into a class.
::ruff::sample::Mixin
Mixin ::ruff::sample
overridable_method
```
OBJECT overridable_method 
```
This method will be overridden in the derived class
::ruff::sample::Base
overridable_method
```
OBJECT overridable_method 
```
This method overrides the one defined in Base.
::ruff::sample::Derived
proc_full
```
proc_full arg ?optarg? ?args?
```
This first line is the summary line for documentation.
::ruff::sample

proc_with_custom_synopsis A B C D
proc_with_custom_synopsis DIFFERENT_PARAM_SIG
proc_with_custom_synopsis X Y args

This is a proc with a custom synopsis ::ruff::sample

proc_without_docs
```
proc_without_docs first_arg second_arg
```
::ruff::sample

property

OBJECT property PROPERTYNAME
OBJECT property PROPERTYNAME ?VALUE?

Method with custom synopsis ::ruff::sample::Base

tcl9
```
tcl9 
```
::ruff
version
```
version 
```
Returns the Ruff! version.
::ruff