Creating Javadocs automatically

Hi

I have been using IDEA for about a month now - moved from a JDE / Emacs
background.

This question might be trivial, I have not found the answer yet.

I need to generate java doc templates for my java class, methods and
public / protected variables, ie for


public String foo()
{
return "";
}

I want to generate

/** Complete foo here

  • @return food

*/

JDE does this by doing a Check JavaDoc.

Is there an equivalent in IDEA?

thanks in advance

anand
Anand Sankaran

8 comments
Comment actions Permalink

I want to generate

>

/

    • Complete foo here

  • @return food

*/


Write "/**" before the method and press Enter.


0
Comment actions Permalink

Thanks. But this is on a method-by-method or a variable-by-variable
case, right?

I want to be able to select a class and say, 'Generate java doc for all
elements in this class',

anand

Carlos Costa e Silva wrote:
>>I want to generate
>>
>>/** Complete foo here
>> * @return food
>> */


Write "/**" before the method and press Enter.


0
Comment actions Permalink

Thanks. But this is on a method-by-method or a variable-by-variable
case, right?

I want to be able to select a class and say, 'Generate java doc for all
elements in this class',


What is the point of generating rather meaningless (in this case) javadoc?

--
Dmitry Skavish
-


Boston, MA, USA
tel. +1 781 370-6909
http://www.jzox.com
http://www.flashgap.com

0
Comment actions Permalink

How IDEA should know, what the methods should do?

Tom

0
Comment actions Permalink

Dmitry Skavish wrote:
>> Thanks.  But this is on a method-by-method or a variable-by-variable
>> case, right?
>>
>> I want to be able to select a class and say, 'Generate java doc for
>> all elements in this class',


What is the point of generating rather meaningless (in this case) javadoc?


I need all the templates to be generated at one shot.  I will go ahead
and fill in the details.  Instead of going to one public method at a
time, I would like to generate the javadoc templates for all methods and
then I can go edit javadocs for one method at a time.

Again, JDE does this, which I find very useful.

anand

0
Comment actions Permalink

Thomas Singer wrote:

How IDEA should know, what the methods should do?

Tom


It need not. All it has to is to create the empty templates.

Today, when you type in /** and press enter, it fills in the template
for the javadoc right, I need a feature that does this for all methods
and instance members.

Once these are generated, I can go ahead and fill in these templates
with meaningful information.

anand

0
Comment actions Permalink

It need not. All it has to is to create the empty templates.

>

I can go ahead and fill in these templates
with meaningful information.


Not very different than going to each method and press /** is it?


0
Comment actions Permalink

Why you don't want to type /** on each method? You still need to go to each method's JavaDoc to type useful information. What's wrong with hitting these 4 keys? Why bother to write JavaDoc at all? Tom On Fri, 30 May 2003 16:28:50 -0700, Anand Sankaran wrote: >Thomas Singer wrote: >> How IDEA should know, what the methods should do? >> >> Tom > >It need not. All it has to is to create the empty templates. > >Today, when you type in /** and press enter, it fills in the template >for the javadoc right, I need a feature that does this for all methods >[public, protected, default acess] and instance members. > >Once these are generated, I can go ahead and fill in these templates >with meaningful information. > >]]>anand

0

Please sign in to leave a comment.