hc-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Mike Bowler <mbow...@GargoyleSoftware.com>
Subject Bug 16429: Align the code base with checkstyle
Date Thu, 30 Jan 2003 20:58:59 GMT
Patch five (in bugzilla) fixes the last of the simple checkstyle warnings.

http://issues.apache.org/bugzilla/show_bug.cgi?id=16429

The URI class has some variables that I can't provide javadoc for 
because quite simply, I don't understand what they're used for.  There 
are some comments there but they make no sense to me.  If someone who 
understands the URI class could provide javadoc for these, it would be 
appreciated.  They start on line 1532.

There are lots of TODO: comments in the code.  There were also a bunch 
of FIXME: comments which I've changed to "TODO" because checkstyle will 
warn us about TODO but not FIXME.  Longer term we should probably change 
checkstyle to look for FIXME as well but for now it was easier to change 
those comments.

Two of the javadoc "@see" tags are longer than 100 characters.  Since 
javadoc doesn't like its tags broken onto multiple lines, I'd like to 
have checkstyle ignore line lengths on @see tags like it does for the 
header line.

While there are lots of "line is too long" warnings left, none of these 
are over 100 characters so assuming that we change checkstyle to have a 
maximum size of 100, all these will go away.  (the current setting is 
still 80).

Whats left after that are things that can't be changed without possibly 
breaking code that uses httpclient.  Public or protected variables with 
names that don't conform to the checkstyle rules.

-- 
Mike Bowler
Principal, Gargoyle Software Inc.
Voice: (416) 822-0973 | Email  : mbowler@GargoyleSoftware.com
Fax  : (416) 822-0975 | Website: http://www.GargoyleSoftware.com



Mime
View raw message