build 607

javadoc @see isn't treated right by the syntax checker - marks errors where
they shouldn't be


from http://java.sun.com/products/jdk/1.1/docs/tooldocs/win32/javadoc.html:
@see classname 
        Adds a hyperlinked "See Also" entry to the class. Some examples are:

            @see #equals                                            // [Note
1]
            @see java.lang.String
            @see String
            @see String#equals                                      // [Note
2]
            @see Character#MAX_RADIX
            @see java.lang.Object#wait(int)                         // [Note
3]
            @see java.applet.Applet#getParameter(java.lang.String)  // [Note
4]
        Note 1 - This works only if equals is in the current class. First
javadoc looks for a field, then a method with that name. 
        Note 2 - This is the proper syntax in version 1.1.x if the @see
statement is in a class other than String. 
        Note 3 - Supplying a method argument type as shown will distinguish
among methods with the same name. 
        Note 4 - In version 1.1.x, the argument type must be
fully-qualified, as shown. 
        Note that a URL (as follows) is not allowed in an @see tag in
version 1.1.x:
        @see <a href="spec.html">Java Spec</a> 
        The workaround is to include this URL in the comment before the
tags. 
        The character # separates the name of a class or interface from the
name of one of its fields, methods, or constructors. One of several
overloaded methods or constructors may be selected by including a
parenthesized list of argument types after the method or constructor name.
Whitespace in @see's classname is significant. If there is more than one
argument, there must be a single blank character between the arguments. For
example: 
            @see java.io.File#File(java.io.File, java.lang.String)
        A doc comment may contain more than one @see tag. 



Colin Stuart
Anuvio Technologies

_______________________________________________
Eap-list mailing list
[EMAIL PROTECTED]
http://www.intellij.com/mailman/listinfo/eap-list

Reply via email to