Bug 40929 - Misleading comments in StandardClassLoader
Summary: Misleading comments in StandardClassLoader
Status: RESOLVED FIXED
Alias: None
Product: Tomcat 5
Classification: Unclassified
Component: Catalina (show other bugs)
Version: Unknown
Hardware: All All
: P2 trivial (vote)
Target Milestone: ---
Assignee: Tomcat Developers Mailing List
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2006-11-08 14:23 UTC by Robert Young
Modified: 2006-11-10 13:07 UTC (History)
0 users



Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Robert Young 2006-11-08 14:23:40 UTC
Sometime during the Tomcat 5 development, the StandardClassLoader in
org.apache.catalina.loader package was stripped down, and is now just a
URLClassLoader.

I work with code that extends the StandardClassLoader (we use the automatic
reloading of jar files), and during an upgrade from tomcat 4 to tomcat 5.5 found
difficultly trying to figure out what had happened to the code.  I ended up
having to install SVN and do a svn log to figure out why the code was removed.

When the code was stripped down, the comments in the java file (and therefore in
the javadoc api) remained identical, so the javadoc api for the class is very
misleading.  For instance, the comments say that the class implements Reloader,
when it in fact does not.

The class comments should be updated to reflect the state of the code.

I can't see this as being very high priority, but it would likely be an easy to
fix for people whom are in the code regularly, and it would make the javadoc
much more readable for people that extend the StandardClassLoader for their own
purposes.
Comment 1 Mark Thomas 2006-11-10 13:07:34 UTC
This has been fixed in SVN and will be in 5.5.21 onwards.