I think I understand where you are coming from.  My concern is that when I have to deal with other peoples code that it may have been done in such a way to cause every method to have one of these syntax errors displayed even though it's valid javadoc.  This would make the error and warning highlighting much less useful as it would become too cluttered with false alarms.  Infact it would be completely distracting.
 
Regards,
 
Glen Stampoultzis
 
 
----- Original Message -----
Sent: Saturday, March 02, 2002 12:37 AM
Subject: RE: [Eap-list] Bug with javadoc error highlighting

Glen,

 

Yes it’s right. But the example I gave is also valid (from javadoc point of view). Should IDEA handle it?

 

You see, javadoc specification has so many ways to write some not-quite-right javadocs which are still processed by javadoc. I do think that IDEA should be stricter concerning javadoc than the original Sun tool. In spite of there’s some JDK documentation, which is written that way.

 

Best regards,

Mike Aizatsky.

------------------------------

IntelliJ Software, "Develop with pleasure!" http://www.intellij.com

 

-----Original Message-----
From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED]] On Behalf Of Glen Stampoutlzis
Sent:
Friday, March 01, 2002 3:58 PM
To: [EMAIL PROTECTED]
Subject: Re: [Eap-list] Bug with javadoc error highlighting

 

 

The example was pulled from the JDK source for the Byte class.  If it's valid javadoc Idea should handle it IMHO.

 

Regards,

 

 Glen

----- Original Message -----

Sent: Friday, March 01, 2002 11:20 PM

Subject: RE: [Eap-list] Bug with javadoc error highlighting

 

Glen,

 

In provided javadoc first <code> tags are really not needed, because javadoc tool already knows that there goes exception name. And about HTML tags in javadoc… From javadoc point “@exception <b>MyException1<p>MyException2</b> someText” is valid. Do you really think IDEA should handle such docs?

 

Best regards,

Mike Aizatsky.

------------------------------

IntelliJ Software, "Develop with pleasure!" http://www.intellij.com

 

-----Original Message-----
From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED]] On Behalf Of Glen Stampoutlzis
Sent:
Friday, March 01, 2002 2:35 PM
To: [EMAIL PROTECTED]
Subject: [Eap-list] Bug with javadoc error highlighting

 

The following is valid javadoc but is displayed as being incorrect by idea:

 

     * @exception <code>ClassCastException</code> if the argument is not a
     *    <code>Byte</code>.

Reply via email to