NatSpec documentation for function return parameter is missing
Summary
The Solidity documentation recommends "that Solidity contracts are fully annotated using NatSpec for all public interfaces (everything in the ABI)." NatSpec documentation should be used for improved readability, a better user experience, enhanced auditability, enablement of automated testing and verification, and to promote standardization and interoperability. (Functions with no NatSpec documentation at all are listed under the "NatSpec documentation for function is missing" issue.)
Vulnerability Details
There is 1 instance of this issue.
| File Link | Instance Count | Instance Link |
|---|---|---|
| Lender.sol | 1 | 130 |
Impact
Decreased readability and usability.
Tools Used
baudit: a custom static code analysis tool; manual review
Recommendations
Add NatSpec documentation for all return parameters from public functions.
Prize pool breakdown
Live
The contest is live. Earn rewards by submitting a finding.
Appeals
This is your time to appeal against judgements on your submissions.
Appeals Review
Appeals are being carefully reviewed by our judges.