You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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)
The text was updated successfully, but these errors were encountered:
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
Javadoc tool warning
Example Generated Javadoc
The text was updated successfully, but these errors were encountered: