On Friday, Aug 22, 2003, at 10:07 Europe/London, Bill de h�ra wrote:
Alex Blewitt wrote:
The only problem is that there's a lot of stuff to be documented; in JavaMail, for example, the API is 100 classes and around 800 methods -- even assuming a conservative 3 lines per method and 5 lines per class, that's almost 3000 lines of text. It's going to take a long time to put anything in there.
I'd say go for it if you're willing to put the effort in for the JavaDoc, but it should be a low priority overall.
Alex,
Agree on the level of effort involved, however I /believe/ it may be the case that for a Sun/JSR API, you have to include the Javadoc (ie the raw code isn't sufficient). I think it's worth checking what Sun's lic policy with this.
According to the JavaMail license (don't know about the Sun Community Source/Binary LIcence) it just says that you have to implement it so that it's got the same public/protected methods, and same public classes. It doesn't say anything about documentation.
Alex.
