From c5dfb268770999ece0efcab2f47f007dec339264 Mon Sep 17 00:00:00 2001 From: Oleg Sukhodolsky Date: Wed, 30 Nov 2005 13:51:49 +0000 Subject: [PATCH] small doc-fix for JavadocMethod check --- src/xdocs/config_javadoc.xml | 9 --------- src/xdocs/releasenotes.xml | 13 ++++++++++++- 2 files changed, 12 insertions(+), 10 deletions(-) diff --git a/src/xdocs/config_javadoc.xml b/src/xdocs/config_javadoc.xml index 57f288143..6a7aad342 100755 --- a/src/xdocs/config_javadoc.xml +++ b/src/xdocs/config_javadoc.xml @@ -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 @see or {@inheritDoc} tag instead of all the other tags. For example, if the above method was implementing a @@ -414,14 +413,6 @@ public boolean isSomething() com.puppycrawl.tools.checkstyle.Verifier interface, then the Javadoc could be done as: - 
-/** @see com.puppycrawl.tools.checkstyle.Verifier **/
-public int checkReturnTag(final int aTagIndex,
-                          JavadocTag[] aTags,
-                          int aLineNo)
-
- - or: 
 /** {@inheritDoc} */
 public int checkReturnTag(final int aTagIndex,
diff --git a/src/xdocs/releasenotes.xml b/src/xdocs/releasenotes.xml
index cd95b5c47..56b22e86d 100755
--- a/src/xdocs/releasenotes.xml
+++ b/src/xdocs/releasenotes.xml
@@ -10,13 +10,24 @@
 
   
 
+    

+      
Fixed Bugs:

+
+      
    
+        
  • 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)
+        
    • 
+      

+    

+
     

       
New features:

 
       
    
         
  • 
           Applied patch 1344344 by sjq to provide the new
-	  Regexp check that can
+          Regexp check that can
           provide the functionality of the following
           checks: RegexpHeader,