how to create function description / definition in java

Question

Is there someone here can give me idea or informations on how to create a functions definition, same to what we got when we write the signature of a function and than we press ctrl + space, in other world, like this :

File file = new File    ( and when we pressed ctrl+space we got as showing in the picture bellow)

After pressing ctrl + space

I googled a lot but i didn't found any solutions, thanks if someone here can help me.

its called JavaDoc... http://stackoverflow.com/questions/4468669/how-to-generate-javadoc?answertab=votes#tab-top — BDRSuite, Dec 24 '14 at 14:17
Thank you Eran, it helped me, i used a wrong keywords when i googled ... thank you dear :) — Ahmad MOUSSA, Dec 24 '14 at 14:28

score 4 · Accepted Answer · answered Dec 24 '14 at 14:15

Read about the Javadoc.

Look the File class source for an example:

/**
 * Creates a new <code>File</code> instance by converting the given
 * pathname string into an abstract pathname.  If the given string is
 * the empty string, then the result is the empty abstract pathname.
 *
 * @param   pathname  A pathname string
 * @throws  NullPointerException
 *          If the <code>pathname</code> argument is <code>null</code>
 */

score 1 · Answer 2 · answered Dec 24 '14 at 14:17

1

This is a good manual about javadocs

answered Dec 24 '14 at 14:17

Pegerto

614
5
18

how to create function description / definition in java

2 Answers2