Bug 42402 - Javadoc overhaul
Summary: Javadoc overhaul
Status: RESOLVED FIXED
Alias: None
Product: BCEL - Now in Jira
Classification: Unclassified
Component: Main (show other bugs)
Version: 5.3
Hardware: Other other
: P2 enhancement
Target Milestone: ---
Assignee: issues@commons.apache.org
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2007-05-13 02:42 UTC by Charlie Nolan
Modified: 2008-02-02 11:31 UTC (History)
0 users



Attachments
SVN diff of trunk overhauling the javadoc comments. (84.05 KB, patch)
2007-05-16 12:28 UTC, Charlie Nolan
Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Charlie Nolan 2007-05-13 02:42:38 UTC
I was using BCEL for a school project over the last few months and noticed that
the Javadoc needs improvement in some areas.  Having free time on my hands after
the end of the project (and semester), I'm interested in doing a (likely large
or multi-part) patch to flesh it out.

Two questions:
1. Is anyone else working on this currently?
2. Which source code base should I work on?  (My guess is
http://svn.apache.org/repos/asf/jakarta/bcel/trunk/src/main)

I'll be starting sometime in the next week.  Family is visiting until Monday, so
I'm not entirely sure when I'm free right now.

Thanks.
-Charlie
Comment 1 Torsten Curdt 2007-05-14 09:24:08 UTC
Charlie, your help would surely be appreciated.
Trunk would be the right place for it.
Cheers, Torsten
Comment 2 Charlie Nolan 2007-05-16 12:02:40 UTC
TYPE_NAMES, CLASS_TYPE_NAMES, and SHORT_TYPE_NAMES (in
org.apache.bcel.Constants) were missing entries for T_ADDRESS.  Entries
"address", ILLEGAL_TYPE, and ILLEGAL_TYPE (respectively) have been added to my copy.

I should have a patch for Constants.java momentarily, I'm around 98% through the
file.

-Charlie
Comment 3 Charlie Nolan 2007-05-16 12:28:15 UTC
Created attachment 20209 [details]
SVN diff of trunk overhauling the javadoc comments.

Ran into one more problem in Constants.java.  There was a broken TODO
(misspelled as TOFO) on ATTRIBUTE_NAMES, saying "FIXXXXX".  The array looks
fine to me, though using ATTR_UNKNOWN could be a problem, as it's got value -1.
 I fixed the TODO, added a warning to the Javadoc, and left a similar
explanation to this one in the code.

Anyway, here's the svn diff of trunk for Constants.java.
Comment 4 Charlie Nolan 2007-05-16 18:07:02 UTC
Waiting for feedback before I go onwards.  Just to make sure I'm on the right track.
Comment 5 Torsten Curdt 2008-02-02 11:31:23 UTC
thanks ....applied! sorry for the delay. please cross check