Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
RichardWarburton opened this issue Dec 17, 2020 · 0 comments
Closed

Comments

@RichardWarburton
Copy link
Contributor

RichardWarburton commented Dec 17, 2020

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)
mjpt777 added a commit that referenced this issue Dec 18, 2020
@mjpt777 mjpt777 closed this as completed Dec 18, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants