Skip to content

"no @return" Javadoc warnings in generated code for set entries. #828

Closed
@RichardWarburton

Description

@RichardWarburton

The javadoc tool emits a warning if you have javadoc with a missing @return entry. Generally SBE generates @return javadoc correctly but if you have a description for an SBE set choice then javadoc on the setter for the relevant bitset class will be generated without an @return.

SBE xml source snippet

<set name="ExecInst" encodingType="uInt8">
  <choice name="AON" description="1=All Or None,0=Not All Or None">0</choice>
</set>

Javadoc tool warning

/path/to/ExecInstEncoder.java:65: warning: no @return
    public ExecInstEncoder aON(final boolean value)

Example Generated Javadoc

    /** 
     * 1=All Or None,0=Not All Or None
     *
     * @param value true if AON is set or false if not.
     */
    public ExecInstEncoder aON(final boolean value)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions