Productivity! Easy.JavaDoc Page (Project Properties Dialog Box)

The Easy.JavaDoc page of the Productivity! Project Properties pages allows to specify the following options:

  1. Policy how to handle existing JavaDoc comments
  2. Methods JavaDoc Generation
  3. Classes JavaDoc Generation
  4. Auto Generation

See also: Productivity! Options Property Page, Productivity! Cache Property Page, Productivity! Code Style Property Page, Productivity! Options

To set these options for all the new projects, choose Project | Default Project Properties menu item.

All the options on this page are applicable to JavaDoc generation by both manual invocation of Easy.JavaDoc (CUA shortcut is CTRL+D) and by invoking Easy.JavaDoc during method generation (in Override.Insight, Constructor.Insight, Implement.Interface and Smart.Instantiate tools)

Please note that all these options are not applicable to the code generated for anonymous classes, since JavaDoc is never generated for them.

If JavaDoc already Exists

This options allows you to specify processing policy for existing JavaDoc comments.

You may define how Easy.JavaDoc will handle the existing JavaDoc comments. If JavaDoc already exists for a method or class, Easy.JavaDoc may either skip the generation of JavaDoc template and override the existing block by its own one, or prompt your confirmation for overriding of the existing comment.

Methods JavaDoc Generation

These options allow you to specify the tags that will be included into the generated JavaDoc template for the method.

By default, Easy.JavaDoc always generates @param, @throw and @return (except for void methods and constructors) tags based on the method definition. However, you may expand content of generated template using Methods JavaDoc Generation option. You may select appropriate checkbox to enable generation of corresponding tag. Please note that if you select "Generate @author" check box, the Easy.JavaDoc will use name of the Author as one is specified on Project Properties | General property page.

Classes JavaDoc Generation

This options allows you to specify which tags should be included into generated JavaDoc template for the class.

By default, Easy.JavaDoc always generates a description only. However, you may expand the content of generated template via the Classes JavaDoc Generation option. You may select the appropriate checkbox to enable generation of the corresponding tag. Please note that if you select the Generate @author checkbox, the Easy.JavaDoc will use the name of the Author as specified on the Project Properties | General property page. The same happens with the Generate @version checkbox.

Auto Generation

You may specify whether default comments should be generated for the get/set methods using the  Automatically generate text of comments for get/set methods checkbox . If you enable this checkbox together with the automatic generation of JavaDoc during methods generation (Project Properties | Productivity! | Code Style | General), then GetSet.Creator tool will insert default description for the method, default description for the method return value (getter) and default description for the method parameters (setter).

See also: Productivity! Options Property Page, Productivity! Cache Property Page, Productivity! Code Style Property Page, Productivity! Options