create a JavaDoc for processing library.

clankill3r

create a JavaDoc for processing library.

in Library and Tool Development • 1 year ago

I'm working on creating a JavaDoc for a processing library.

I only have a few problems.

How can i display text by the Field Summary? @param doesn't seem to work since it's not a parameter?

And there is a Constructor Summary and Method Summary, i can get text there, however there is also a 'Constructor Detail' and a 'Method Detail' that often contains a more detailed explanation. I only don't know how to get more text there, for now it's just the same text as by the summary.

hope someone can help.

Replies(3)

calsign

Re: create a JavaDoc for processing library.

1 year ago

Fields work just like methods; put the Javadoc comment before the field, like this:

/**
* PI, the ratio of a circle's circumference to it's diameter
*/
final static int PI = 3.14;

As far as I can tell, the Javadoc will take the first line... or paragraph (separated with HTML <p>s)... of the reference for the summary, and use everything to create the detail. It hasn't worked that well for me in the past...

clankill3r

Re: create a JavaDoc for processing library.

1 year ago

Ah, i tried @param for the field.

And you are right about the <p> </p>, works well so far, and let's hope it stays like that.

quarks

Re: create a JavaDoc for processing library.

1 year ago

I think you will find that the Detail will use all the text in the comment but the Summary will only use the text upto the first full-stop.

    /**
    * Restore images back to their original state. Useful if
    * you have used the bite() method.
    */
    public void restoreImages(){
        frames = S4P.getFrames(info);
    }

BTW JavaDoc does not document private or protected stuff.