Bug 28335 - janitorial javadoc clean ups to jakarta-tomcat-catalina
Summary: janitorial javadoc clean ups to jakarta-tomcat-catalina
Status: RESOLVED FIXED
Alias: None
Product: Tomcat 5
Classification: Unclassified
Component: Catalina (show other bugs)
Version: Unknown
Hardware: All All
: P5 minor (vote)
Target Milestone: ---
Assignee: Tomcat Developers Mailing List
URL:
Keywords: PatchAvailable
Depends on:
Blocks:
 
Reported: 2004-04-10 22:55 UTC by Sandy McArthur
Modified: 2006-09-28 04:21 UTC (History)
0 users


Attachments
catalina javadoc clean ups (81.30 KB, patch)
2004-04-10 22:55 UTC, Sandy McArthur 		Details | Diff
View All Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Sandy McArthur 2004-04-10 22:55:11 UTC 
The to be attached patch cleans up only JavaDoc comments that have one of the
following problems:

Corrected @param names is wrong or misspelled
Removed @param names that don't exists
Removed @param names that have no description
Removed @return tags without a description
Removed @exception tags for exceptions that are not thrown by the method
Corrected @see tags

In the case where it wasn't obivious how to fix a javadoc comment, I just left
it alone.
Comment 1 Sandy McArthur 2004-04-10 22:55:58 UTC 
Created attachment 11212 [details]
catalina javadoc clean ups
Comment 2 Yoav Shapira 2004-05-26 16:43:28 UTC 
Changes made and committed (along with a few more JavaDoc fixes).