-
Notifications
You must be signed in to change notification settings - Fork 4
Options
StevenGBrown edited this page May 14, 2017
·
3 revisions
To access the Options page, open a Javadoc page with the javadoc-search-frame script enabled. Click on the Options link underneath the search field.
If running the Google Chrome Extension, the Options page can also be opened via chrome://extensions.
Options:
| Option | Description |
|---|---|
| hide_package_frame | If the package frame is not hidden, only the classes list can be searched. |
| class_menu | Menu displayed when pressing the @ key if a class if currently displayed at the top of the search list. See the Configuring the menu options section for more information. |
| package_menu | Menu displayed when pressing the @ key if a package is currently displayed at the top of the search list. See the Configuring the menu options section for more information. |
The class_menu and package_menu options are specified in the format:
@mnemonic:label -> url
See the default values of these options for an example. The URL can contain aliases which are replaced with information about the selected package, class or method:
| Alias | Description |
|---|---|
##CLASS_NAME## |
The name of the class currently displayed at the top of the search list. |
##PACKAGE_NAME## |
The name of the package currently displayed at the top of the search list or the package containing the class currently displayed at the top of the search list. |
##PACKAGE_PATH## |
The name of the package currently displayed at the top of the search list with period characters (.) replaced with forward slash characters (/). |
##MEMBER_NAME## |
In class member search mode, the name of the class member currently displayed at the top of the search list. ##METHOD_NAME## and ##FIELD_NAME## are also recognised. |