users@jaxb.java.net

Cleanup generated Javadoc comments do avoid warnings

From: Gerry Plummer <gerry_at_TELOQUENT.COM>
Date: Thu, 24 Jul 2003 09:41:56 -0600

The generated code includes javadoc comments for the various getter/setter methods. If a property can be empty (schema has minOccurs=0)then the comments for the getter/setter methods attempt to show that null is a possible/valid parameter, as well as the type of a valid, non-null parameter, using a javadoc @link tag. The {_at_link null} produces huge numbers of annoying javadoc warnings that clutter up our build logs. E.g.

N:\java\com\teloquent\net\message\bind\tqlink\ReasonType.java:44: warning - Tag @link: reference not found: null

Here's part of the generated class:


/** * Java content class for ReasonType complex type.
 * <p>The following schema fragment specifies the expected content contained within this java content object.
 * <p>
 * <pre>
 * &lt;complexType name="ReasonType">
 * &lt;complexContent>
 * &lt;restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
 * &lt;sequence>
 * &lt;element name="Code" type="{http://www.w3.org/2001/XMLSchema}int"/>
 * &lt;element name="Description" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
 * &lt;/sequence>
 * &lt;/restriction>
 * &lt;/complexContent>
 * &lt;/complexType>
 * </pre>
 */
public interface ReasonType {

    /**
     *
     * @return possible object is
     * {_at_link null}
     * {_at_link java.lang.String}
     */
    java.lang.String getDescription();

    /**
     *
     * @param value allowed object is
     * {_at_link null}
     * {_at_link java.lang.String}
     */
    void setDescription(java.lang.String value);

    int getCode();

    void setCode(int value);

}