Viewing Inline Documentation
On this page:
- Type inference support in Quick Documentation
- Documentation comments
- Viewing quick documentation
- Toolbar of the quick documentation lookup
Quick Documentation Lookup helps you get quick information for any symbol or just method signature information, provided that this symbol has been supplied with documentation comments in the applicable format.
Type inference support in Quick DocumentationAppCode handles the Quick Documentation for the inferred types of symbols for all the supported languages. The IDE infers the type of the expression based on the provided values and renders that information in the Quick Documentation Window.
Refer to the sections below for general procedures of the Quick Documentation presentation.
AppCode handles the Quick Documentation for a symbol from the line comments that start with the three slashes.
Documentation comments can be applied to the following symbols: class, structure, enum, protocol, interface, variable, property, parameter, method, etc. Refer to the sections below for general procedures of the Quick Documentation presentation.
Viewing quick documentation
To view documentation for a symbol at caret, do one of the following
- On the main menu, choose .
- Press N/A.
- Provided that the check box Show quick doc on mouse move in the editor settings is selected, just move your mouse pointer over the desired symbol.
When you explicitly invoke code completion, then quick documentation for an entry selected in the suggestion list can be displayed automatically. The behavior of quick documentation lookup is configured in the Code Completion page of the Settings/Preferences dialog.
To change the font size of quick documentation, do one of the following
- Click in the upper-right corner of the quick documentation window, and move the slider.
- Rotate the mouse wheel while keeping the Ctrl key pressed.
Note that for this feature to work, you have to enable it in the General page of the editor settings.
Refer to the section Zooming in the Editor for details.
Toolbar of the quick documentation lookup
The Quick Documentation Lookup window helps navigate to the related symbols via hyperlinks, and provides a toolbar for moving back and forth through the already navigated pages, changing font size, and viewing documentation in an external browser.
|N/A or N/A||Switch to the previous or next documentation page (e.g. after using hyperlinks). |
You can also use the three-finger right-to-left and left-to-right swipe gestures.
|N/A||View external documentation in the default browser.|
|N/A||Switch to the item (e.g. source) that corresponds to the documentation page currently shown.|
|Turn the Auto-update from source option on or off. When the option is on, the information in the tool window is synchronized with your navigation in the editor and other places in the UI.|
|Click this icon to show font size slider. Move the slider to increase or decrease the font size in the quick documentation window as required.|