The full specification of the javadoc stubs generation feature(s) is not ready yet, but we indeed do not plan to generate such useless comments (at least, by default).
Best regards, Valentin Kipiatkov ----------------------------------------------------------- IntelliJ Software, http://www.intellij.com/ "Develop with pleasure" ----------------------------------------------------------- ----- Original Message ----- From: "Thomas Singer" <[EMAIL PROTECTED]> To: <[EMAIL PROTECTED]> Sent: Wednesday, February 20, 2002 6:41 PM Subject: Re: AW: [Eap-list] Marking JavaDoc errors > -10 > > Oh, no! Have a look at a lot of Netbeans source and you see the result: > useless, autogenerated JavaDocs like following: > > /** Holds value of property ignoreCase. */ > private boolean ignoreCase; > > /** Getter for property beforeDate. > * @return Value of property beforeDate. > */ > public String getBeforeDate1() { > return beforeDate1; > } > > /** Setter for property beforeDate. > * @param beforeDate New value of property beforeDate. > */ > public void setBeforeDate1(String beforeDate) { > this.beforeDate1 = beforeDate; > } > > Tom > > At 13:41 20.02.02 +0100, you wrote: > >Uhhm... > > > >What about an option called "Update JavaDocs when formatting code", that > >creates those stubs on Ctrl-Alt-F? > > > > > > > >Johannes Schneider > > > > > >-----Urspr�ngliche Nachricht----- > >Von: Mike Aizatsky [mailto:[EMAIL PROTECTED]] > >Gesendet: Mittwoch, 20. Februar 2002 13:02 > >An: [EMAIL PROTECTED] > >Betreff: RE: [Eap-list] Marking JavaDoc errors > > > >Johannes, > > > > > And it would be wonderful, if IDEA helped us more to create those > >JavaDocs > > > >It's planned feature for Ariadna to generate JavaDoc stubs. > > > > > and to keep them up-to-date... > > > >Currently IDEA automatically update @param, @see, @throws tags on > >rename. It will also update @see tags on change signature. Do you think > >IDEA can do some more with this? > > > >Best regards, > >Mike Aizatsky. > >------------------------------ > >IntelliJ Software, "Develop with pleasure!" http://www.intellij.com > > > > > > > -----Original Message----- > > > From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED]] > >On > > > Behalf Of Johannes Schneider > > > Sent: Wednesday, February 20, 2002 2:49 PM > > > To: '[EMAIL PROTECTED]' > > > Subject: AW: [Eap-list] Marking JavaDoc errors > > > > > > Yes, we agree :) > > > > > > > > > And it would be wonderful, if IDEA helped us more to create those > >JavaDocs > > > and to keep them up-to-date... > > > > > > > > > Johannes Schneider > > > > > > -----Urspr�ngliche Nachricht----- > > > Von: Mike Aizatsky [mailto:[EMAIL PROTECTED]] > > > Gesendet: Mittwoch, 20. Februar 2002 12:30 > > > An: [EMAIL PROTECTED] > > > Betreff: [Eap-list] Marking JavaDoc errors > > > > > > Hi, All > > > > > > There are several requests to change JavaDoc errors marking to be not > > > red. I'd like to argument our decision and to hear your opinion. > > > > > > The most common critique of current highlighting is the fact that > > > compiler will compile the file without errors. But JavaDoc _will_ > > > produce errors (well, at least it should :). And if there are some > > > errors in JavaDoc, chances are quite high that JavaDoc is outdated. > >And > > > is outdated JavaDoc better than not having it at all? I think not much > > > better. Just look through some Sun's classes. There's plenty of > >JavaDoc > > > errors. And we, developers, should read it and try to figure out what > > > should be instead of the error text. > > > > > > So, the question is: are JavaDoc errors serious ones? The answer seems > > > to be "yes". If you have documentation, you must keep it consistent or > > > throw away. > > > > > > Do you agree? > > > > > > Best regards, > > > Mike Aizatsky. > > > ------------------------------ > > > IntelliJ Software, "Develop with pleasure!" http://www.intellij.com > > > > > > > > > > > > > > > _______________________________________________ > > > Eap-list mailing list > > > [EMAIL PROTECTED] > > > http://www.intellij.com/mailman/listinfo/eap-list > > > > > > _______________________________________________ > > > Eap-list mailing list > > > [EMAIL PROTECTED] > > > http://www.intellij.com/mailman/listinfo/eap-list > > > > > >_______________________________________________ > >Eap-list mailing list > >[EMAIL PROTECTED] > >http://www.intellij.com/mailman/listinfo/eap-list > > > >_______________________________________________ > >Eap-list mailing list > >[EMAIL PROTECTED] > >http://www.intellij.com/mailman/listinfo/eap-list > > > _______________________________________________ > Eap-list mailing list > [EMAIL PROTECTED] > http://www.intellij.com/mailman/listinfo/eap-list _______________________________________________ Eap-list mailing list [EMAIL PROTECTED] http://www.intellij.com/mailman/listinfo/eap-list
