Previous Next
Browsing documentation

Once you have finished documenting your source code, you can make the documentation readable but not editable by switching the mode of the Documentation Editor to Read Only. When the Documentation Editor is in this mode, it can only be used for browsing documentation.
Switching the Documentation Editor to browsing mode
To switch the Documentation Editor to browsing mode, please complete the following steps:

  1. Choose Preferences... from the Tools menu.
    The Preferences dialog appears.
  2. Select the Documentation Editor node.
    The Documentation Editor view appears.
  3. Under Document Creation, select the Use Read-Only Mode check box.
  4. Press Ok to apply and close your Preferences.
    You can now only browse your documentation.
Browsing a symbol's documentation
You can browse a symbol's documentation in any tool that displays symbolic information.
To browse the documentation of a documented symbol, select the symbol and then choose the Show Documentation of symbol command from the Info menu. The symbol's documentation is then loaded into a Documentation Editor.

Previous Next