</p></li></ul></div></div><div class="sect4" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="javadoc-misc"></a>4.3.9.2.2.&nbsp;Misc</h5></div></div><div></div></div><p>Let's you control miscellaneous Javadoc settings.</p><div class="itemizedlist"><ul type="disc"><li><p>Field comments in single line</p><p>Let's you specify how Javadoc comments of fields, that fit into one line, should be printed.</p><div class="example"><a name="ex-javadoc-field"></a><p class="title"><b>Example&nbsp;4.146.&nbsp;Field Javadoc comment</b></p><table border="0" bgcolor="#E0E0E0" class="shade"><tr><td><pre class="programlisting">/** * What history policy should be used? */private History.Policy _historyPolicy = History.Policy.DISABLED;</pre></td></tr></table></div><p>If enabled, Javadoc comments for fields will be printed in a single line,if possible.</p><div class="example"><a name="ex-javadoc-field-short"></a><p class="title"><b>Example&nbsp;4.147.&nbsp;Field Javadoc comment (shortened)</b></p><table border="0" bgcolor="#E0E0E0" class="shade"><tr><td><pre class="programlisting">/** What history policy should be used? */private History.Policy _historyPolicy = History.Policy.DISABLED;</pre></td></tr></table></div><p>Note that this switch does not take affect for field template comments,as template are not parsed but inserted as-is.</p><p>Note further that the <a href="javadoc.html#javadoc-format">Javadoc parsing</a>must be enabled for this feature to work.</p></li></ul></div></div></div><div class="sect3" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="javadoc-templates"></a>4.3.9.3.&nbsp;Templates</h4></div></div><div></div></div><p>Let's you define templates to be inserted for the different declaration elements.Each element (Class, Interface, Constructor, Method and Field) has itsown template.</p><p>Depending on the element type, a template consists of up to five parts thattogether form a valid Javadoc comment. Note that the resulting comment willbe inserted as-is, and it is your responsibility to define the templatesin a consistent style.</p><p>You can use variable expressions throughout your templates. Read<a href="environment.html" title="4.3.8.&nbsp;Environment">Section&nbsp;4.3.8, &#8220;Environment&#8221;</a> for more information about this feature.</p></div><div class="sect3" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="javadoc-tags"></a>4.3.9.4.&nbsp;Custom Tags</h4></div></div><div></div></div><p>Allows the definition of custom Javadoc tags to aid the syntax checking ofJavadoc comments, and enable the auto-correction of misspelled custom tag names.</p><div class="sect4" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="javadoc-tags-standard"></a>4.3.9.4.1.&nbsp;Standard Tags</h5></div></div><div></div></div><p>Allows the definition of custom Javadoc standard tag names. The current build-in Standardtags are:<tt class="literal">@author</tt>,<tt class="literal">@deprecated</tt>,<tt class="literal">@exception</tt>,<tt class="literal">@param</tt>,<tt class="literal">@return</tt>,<tt class="literal">@see</tt>,<tt class="literal">@serial</tt>,<tt class="literal">@serialData</tt>,<tt class="literal">@serialField</tt>,<tt class="literal">@since</tt>,<tt class="literal">@throws</tt>,<tt class="literal">@todo</tt>,<tt class="literal">@version</tt></p><p>Use the <span><b class="guibutton">Add...</b></span> and <span><b class="guibutton">Remove</b></span> buttonsto add or remove items from the list.</p><p>Valid standard tag names have the form<tt class="literal">@[a-zA-Z]+</tt>, e.g. <tt class="literal">@exclude</tt>.</p></div><div class="sect4" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="javadoc-tags-inline"></a>4.3.9.4.2.&nbsp;In-line Tags</h5></div></div><div></div></div><p>Allows the definition of custom Javadoc in-line tag names.The current build-in In-line tags are:<tt class="literal">@docRoot</tt>,<tt class="literal">@inheritDoc</tt>,<tt class="literal">@link</tt>,<tt class="literal">@linkPlain</tt>,<tt class="literal">@value</tt></p><p>Use the <span><b class="guibutton">Add...</b></span> and <span><b class="guibutton">Remove</b></span> buttonsto add or remove items from the list.</p><p>Valid in-line tag names have the form<tt class="literal">@[a-zA-Z]+</tt>, e.g. <tt class="literal">@mylink</tt>.</p></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="environment.html">Prev</a>&nbsp;</td><td width="20%" align="center"><a accesskey="u" href="printer.html">Up</a></td><td width="40%" align="right">&nbsp;<a accesskey="n" href="header.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">4.3.8.&nbsp;Environment&nbsp;</td><td width="20%" align="center"><a accesskey="h" href="manual.html">Home</a></td><td width="40%" align="right" valign="top">&nbsp;4.3.10.&nbsp;Header</td></tr></table></div></td></tr></table></td></tr><tr><td bgcolor="#eeeecc" height="17" style="font-size:9px;padding-left:5px"><a href="#toppage">to top</a></td></tr><tr><td height="30"><br></td></tr><tr><td height="3"></td></tr><tr><td bgcolor="#336699" height="1"></td></tr><tr><td height="1"></td></tr><tr><td bgcolor="#336699" height="16"></td></tr><tr><td bgcolor="#ff9966" height="4"></td></tr><tr><td class="footer" align="center" height="15" valign="middle">            Copyright &copy; 2001-2004, <a class="footer" href="./contact.html">Marco Hunsicker</a>. All rights reserved. Hosted by <a href="http://sourceforge.net">SourceForge.net</a></td></tr></tbody></table><img src="http://sourceforge.net/sflogo.php?group_id=45216&amp;type=1" width="1" height="1" border="0" hspace="0" vspace="0" alt=""></body></html>