mirror of
https://gitflic.ru/project/openide/openide.git
synced 2025-12-15 02:59:33 +07:00
130 lines
6.3 KiB
HTML
130 lines
6.3 KiB
HTML
<html>
|
|
<body>
|
|
<table width="100%" border="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse">
|
|
<tr>
|
|
<td><font face="verdana" size="-1">
|
|
Defines template which used to generate JavaDoc for the overriding methods, e.g.
|
|
when <i>Add Javadoc</i> intention action is applied.<br><br>
|
|
|
|
Along with Java expressions and comments, you can also use the predefined variables
|
|
that will then be expanded like macros into corresponding values.<br><br>
|
|
|
|
By using the <i>#parse</i> directive, you can include templates from the <b>Includes</b> tab. To include a template,
|
|
specify the full name of the template as a parameter in quotation marks (for example, <i>#parse("File Header.java")</i>.
|
|
</font></td>
|
|
</tr>
|
|
</table>
|
|
<table width="100%" border="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse">
|
|
<tr>
|
|
<td colspan="3"><font face="verdana" size="-1">Predefined variables take the following values:</font></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><nobr><font face="verdana" size="-2"><b>${PARAMS}</b></font></nobr></td>
|
|
<td width="10"> </td>
|
|
<td width="100%" valign="top"><font face="verdana" size="-1">List of the parameter names</font></td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><nobr><font face="verdana" size="-2"><b>${TYPE_PARAMS}</b></font></nobr></td>
|
|
<td width="10"> </td>
|
|
<td width="100%" valign="top"><font face="verdana" size="-1">List of the type parameter names</font></td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><nobr><font face="verdana" size="-2"><b>${THROWS}</b></font></nobr></td>
|
|
<td width="10"> </td>
|
|
<td width="100%" valign="top"><font face="verdana" size="-1">List of the thrown exceptions</font></td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><nobr><font face="verdana" size="-2"><b>${RETURN_TYPE}</b></font></nobr></td>
|
|
<td width="10"> </td>
|
|
<td width="100%" valign="top"><font face="verdana" size="-1">Type returned by the method</font></td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><nobr><font face="verdana" size="-2"><b>${PARAMS_INHERITED}</b></font></nobr></td>
|
|
<td width="10"> </td>
|
|
<td width="100%" valign="top"><font face="verdana" size="-1">List of the parameters with descriptions of the super method</font></td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><nobr><font face="verdana" size="-2"><b>${ELEMENT_NAME}</b></font></nobr></td>
|
|
<td width="10"> </td>
|
|
<td width="100%" valign="top"><font face="verdana" size="-1">Name of the class member which is owner for the generated JavaDoc</font></td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><nobr><font face="verdana" size="-2"><b>${CONTAINING_CLASS}</b></font></nobr></td>
|
|
<td width="10"> </td>
|
|
<td width="100%" valign="top"><font face="verdana" size="-1">Name of the parent class</font></td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><nobr><font face="verdana" size="-2"><b>${SUPER_METHOD}</b></font></nobr></td>
|
|
<td width="10"> </td>
|
|
<td width="100%" valign="top"><font face="verdana" size="-1">Fully qualified name of the super method</font></td>
|
|
</tr>
|
|
<!--Copied from file-->
|
|
<tr>
|
|
<td valign="top"><nobr><font face="verdana" size="-2"><b>${PACKAGE_NAME}</b></font></nobr></td>
|
|
<td width="10"> </td>
|
|
<td width="100%" valign="top"><font face="verdana" size="-1">Name of the package in which a new enum is created</font></td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><nobr><font face="verdana" size="-2"><b>${NAME}</b></font></nobr></td>
|
|
<td width="10"> </td>
|
|
<td width="100%" valign="top"><font face="verdana" size="-1">Name of the new enum specified by you in the <b>Create New Class</b> dialog</font></td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><nobr><font face="verdana" size="-2"><b>${USER}</b></font></nobr></td>
|
|
<td width="10"> </td>
|
|
<td width="100%" valign="top"><font face="verdana" size="-1">System login name of the current user</font></td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><nobr><font face="verdana" size="-2"><b>${DATE}</b></font></nobr></td>
|
|
<td width="10"> </td>
|
|
<td width="100%" valign="top"><font face="verdana" size="-1">Current system date</font></td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><nobr><font face="verdana" size="-2"><b>${TIME}</b></font></nobr></td>
|
|
<td width="10"> </td>
|
|
<td width="100%" valign="top"><font face="verdana" size="-1">Current system time</font></td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><nobr><font face="verdana" size="-2"><b>${YEAR}</b></font></nobr></td>
|
|
<td width="10"> </td>
|
|
<td width="100%" valign="top"><font face="verdana" size="-1">Current year</font></td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><nobr><font face="verdana" size="-2"><b>${MONTH}</b></font></nobr></td>
|
|
<td width="10"> </td>
|
|
<td width="100%" valign="top"><font face="verdana" size="-1">Current month</font></td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><nobr><font face="verdana" size="-2"><b>${MONTH_NAME_SHORT}</b></font></nobr></td>
|
|
<td width="10"> </td>
|
|
<td width="100%" valign="top"><font face="verdana" size="-1">First 3 letters of the current month name (Jan, Feb, and so on)</font></td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><nobr><font face="verdana" size="-2"><b>${MONTH_NAME_FULL}</b></font></nobr></td>
|
|
<td width="10"> </td>
|
|
<td width="100%" valign="top"><font face="verdana" size="-1">Full name of the current month (January, February, and so on)</font></td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><nobr><font face="verdana" size="-2"><b>${DAY}</b></font></nobr></td>
|
|
<td width="10"> </td>
|
|
<td width="100%" valign="top"><font face="verdana" size="-1">Current day of the month</font></td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><nobr><font face="verdana" size="-2"><b>${HOUR}</b></font></nobr></td>
|
|
<td width="10"> </td>
|
|
<td width="100%" valign="top"><font face="verdana" size="-1">Current hour</font></td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><nobr><font face="verdana" size="-2"><b>${MINUTE}</b></font></nobr></td>
|
|
<td width="10"> </td>
|
|
<td width="100%" valign="top"><font face="verdana" size="-1">Current minute</font></td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><nobr><font face="verdana" size="-2"><b>${PROJECT_NAME}</b></font></nobr></td>
|
|
<td width="10"> </td>
|
|
<td width="100%" valign="top"><font face="verdana" size="-1">Name of the current project</font></td>
|
|
</tr>
|
|
</table>
|
|
</body>
|
|
</html> |