Re: GNOME -- status and future.



On Fri, 06 Feb, 1998 at 11:30:22PM +0100, Christian Leutloff set free these words:
> 
> Can we please use javadoc like documentation!? The comments for the
> documentation starts with /** 
> 
> Here's an example:
> 
> /**
>  * here is the description for the following class, method, variable, ...
> 
>  * @author Christian Leutloff 
>  * @version 0.1, 06.02.1998
>  */
> 
> public class ...
> {
>    /**
>     * the first function
>     * @param initialValue
>     * @return something useful
>     */
>    public usefulType firstFunc(initType inital)
>    {
> ...
> 
> 
> The javadoc program generates from these comments really useful
> documentation. Look at the JDK documentation which is generated with
> javadoc.
> 
I was thinking this too but here's the question I can't resolve by myself:
How well does javadoc work with non-OO code?  And with OO C Code (like gtk)?

-Toshio
-- 
badger  \"The Difference between today and yesterday is not so much what has
@prtr-13 \ changed between then and now as what I hope to change by tomorrow."
.ucsc.edu  \~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~

PGP signature



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]