xjc-generated classes may have methods with missing @param or @return

[Tomas-Kraus]

Further to commit 0fd1c105c992f77da451e6eb4143617cf85b5fc3 that has this commit comment:

8158221: Added missing javadoc for method parameter and returned value.

(See https://bugs.openjdk.java.net/browse/JDK-8158221 for the report)

This commit doesn't go far enough; it applies only to the generated ObjectFactory.java.

Classes generated by xjc for the users's schema may have getter methods with Javadoc that omits @return, and setter methods with Javadoc that omits @param.

For example, here is the generated code for the getter and setter for a field of type int:

/**
     * Gets the value of the id property.
     *
     */
    public int getId() {
        return id;
    }

    /**
     * Sets the value of the id property.
     *
     */
    public void setId(int value) {
        this.id = value;
    }

Similarly, a generated getter for a value of List type has Javadoc that omits @return.

Its seems that within xjc/src/main/java/com/sun/tools/xjc/generator/bean/field, some of the classes invoke .javadoc().addReturn() and .javadoc().addParam(), and some don't ...

Affected Versions

[2.2.11]

[Tomas-Kraus]

@glassfishrobot Commented
Reported by richardwalker

[Tomas-Kraus]

@glassfishrobot Commented
This issue was imported from java.net JIRA JAXB-1117

[Tomas-Kraus]

• Issue Imported From: xjc-generated classes may have methods with missing @param or @return javaee/jaxb-v2#1117
• Original Issue Raised By:@glassfishrobot
• Original Issue Assigned To: @m0mus