Defines template which used to generate JavaDoc for the classes, interfaces or records, e.g.
when Add Javadoc intention action is applied. Along with Java expressions and comments, you can also use the predefined variables that will then be expanded like macros into corresponding values. By using the #parse directive, you can include templates from the Includes tab. To include a template, specify the full name of the template as a parameter in quotation marks (for example, #parse("File Header.java"). |
Predefined variables take the following values: | ||
List of the record parameters | ||
List of the type parameter names | ||
Name of the parent class | ||
Returns true, when the JavaDoc owner is an interface | ||
Returns true, when the JavaDoc owner is an enum | ||
Returns true, when the JavaDoc owner is a record | ||
Name of the package in which a new enum is created | ||
Name of the new enum specified by you in the Create New Class dialog | ||
System login name of the current user | ||
Current system date | ||
Current system time | ||
Current year | ||
Current month | ||
First 3 letters of the current month name (Jan, Feb, and so on) | ||
Full name of the current month (January, February, and so on) | ||
Current day of the month | ||
Current hour | ||
Current minute | ||
Name of the current project |