Ruby In Steel :: Help Index :: SapphireSteel Software Front Page Return to the Index
IntelliSense Options
See Also

Glossary Item Box

You can specify a variety of options to configure the IntelliSense features available in your Ruby code files.

Completion Lists

Show Completion List After Character Is Typed
The completion list will appear when alphanumeric characters are typed and any matching text pattern will be selected in the list.
Place Keywords In Completion List
Keywords such as def, class and module will be included in the completion list.,
Place Globals In Completion List
Global variables (beginning with $) will be included in the completion list.
Place Snippets In Completion List
Code snippets will be included in the completion list.
Enter key is a commit character
Inserts selected item into code editor on Enter (Tab is the default)


Expand Snippets By Tab Character
When this is selected, you can enter the shortcut of a snippet and press the Tab key in order to cause the snippet to be inserted into the code editor.

IntelliSense Member Completion

Display Object Methods
When this is selected, the methods defined in Ruby's Object class will be included in completion lists along with the methods of descendant classes. You may wish to disable the display of Object methods in order to limit the size of completion lists.

RDoc Display

Display RDOC in Tooltips
When selected any documentation entered into a comment block above a class, module or method definition will be displayed in a tooltip when the mouse pointer hovers over an identifier of the appropriate type in the editor.


Require File Depth
This value determines the number of 'levels' of required files which are parsed in order to provide IntelliSense. If the value is 0, no required files are parsed. If it is 1, only files required by the current code file are parsed; if it is 2, files which are required by the files required by the current file are also parsed and so on.

When setting the 'require file depth', bear in mind that there is a trade-off between completeness and efficiency. Some Ruby class libraries may require files to many levels. In such a case the greater the required file depth, the more complete will be the IntelliSense provided. However, the IntelliSense Inference Engine (the Ruby In Steel tool which analyses code as it is entered) consequently has to do far more work. As a result, the speed at which the code completion lists are updated to reflect any editing changes may deteriorate. As a general rule, we suggest accepting the default Require file depth of 2. 

See Also