Notation used in Ruby API documentation


The documentation of the Ruby API is derived from the C++ declaration of the specific methods. Hence the notation deviates somewhat from the usual documentation of Ruby methods. In particular the following differences are noteworthy:

General layout of the documentatation

The documentation states the following methods (in that order):

Deprecated methods are listed for reference only. Use of such methods or constants is not recommended because they might be removed in the future.


Here are some examples for method documentations (signatures):