TouchInstinct
/
checkstyle
307
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

small doc-fix for JavadocMethod check

This commit is contained in:
Oleg Sukhodolsky 2005-11-30 13:51:49 +00:00
parent 00af541f48
commit c5dfb26877
2 changed files with 12 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
src/xdocs/config_javadoc.xml
View File

@ -406,7 +406,6 @@ public boolean isSomething()
It can be extremely painful writing or duplicating Javadoc
for a method required for an interface. Hence checkstyle
supports using the convention of using a single <span
class="code">@see</span> or <span
class="code">{@inheritDoc}</span> tag instead of all the
other tags. For example, if the <a
href="#checkReturnTag">above method</a> was implementing a
@ -414,14 +413,6 @@ public boolean isSomething()
com.puppycrawl.tools.checkstyle.Verifier</span> interface,
then the Javadoc could be done as:
<pre>
/** @see com.puppycrawl.tools.checkstyle.Verifier **/
public int checkReturnTag(final int aTagIndex,
JavadocTag[] aTags,
int aLineNo)
</pre>
or:
<pre>
/** {@inheritDoc} */
public int checkReturnTag(final int aTagIndex,

13
src/xdocs/releasenotes.xml
View File

@ -10,13 +10,24 @@
<body>
<section name="Release 4.1">
<p>Fixed Bugs:</p>
<ul>
<li>Documentation for JavadocMethod check corrected to
indicate that after fix for 1290379 javadoc which contains
only @see tag is not valid any more (bug 1369615)
</li>
</ul>
</section>
<section name="Release 4.0">
<p>New features:</p>
<ul>
<li>
Applied patch 1344344 by sjq to provide the new
<a href="config_misc.html#Regexp">Regexp</a> check that can
<a href="config_misc.html#Regexp">Regexp</a> check that can
provide the functionality of the following
checks: <a
href="config_header.html#RegexpHeader">RegexpHeader</a>, <a