[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: Classpath docs
From: |
Brian Jones |
Subject: |
Re: Classpath docs |
Date: |
05 May 2002 20:07:38 -0400 |
User-agent: |
Gnus/5.09 (Gnus v5.9.0) Emacs/21.1 |
Julian Scheid <address@hidden> writes:
> Some hints for Classpath documentation authors:
>
> - All package docs are missing (the package.html file
> in the package directories.) This makes the index
> page look somewhat deserted (the right table column
> ought to contain the summaries.)
>
> - There are some classes whose method comments
> all start with "This method .." (see for example
> java.io.DataInput) - which is redundant. See
> java.lang.String for an example of how to do it
> better.
>
> - There are a few typos, like "IlegalArgumentException"
> or "ClassCastExcpetion" which can be easily spotted
> by looking at gjdoc output. I'll see that I fix
> that in CVS when I got some spare time.
I really like the documentation that is being generated by the tool.
Thanks,
Brian
--
Brian Jones <address@hidden>