Skip to content
mkesting edited this page Mar 28, 2019 · 4 revisions

Editor

For source files opened in Editor Javadoc can be added for all or only for selected members. In this case the modified source file will not be saved automatically to disk.

If the cursor is inside the declaration of an field or method, only this element will be documented. To create a type comment point to the name of the type. Otherwise all members of the current source file will be documented.

Options Dialog

Selecting the menus with "..." will open an Options Dialog where it's possible to overrule the current project/workspace settings. These settings will only be effective for the current compilation unit and only for this Eclipse session.

Preview Dialog

When using the Options Dialog in Editor it's possible to see a Preview of all changes.

Package Explorer

In Package Explorer you can select one or more source file(s) in order to add Javadoc. Alternatively, you can select a package and add Javadoc for all package members or you can do it for the complete project.

Caution: Source files which are not opened in the editor will be saved directly to disk.

Clone this wiki locally