A patch to add in missing @param and @return annotation tags in the EndpointV2.sol file, as well as code formatting, fix some misspelling and text, and also convert the comments from regular // format to NatSpec format, according to the other Solidity code files from the repository.
Overview:
This patch follows my merged pull request from devtools, where I added a missing @return annotation tag to the quote() function on MyOApp.sol. This function is the same as the quote() function found on EndpointV2.sol. In addition to this function, other functions missing both @param and @return annotation tags were patched.
All added annotation tags and descriptions were done based on similar annotation tags and descriptions of all contracts from this repository, as well as devtools and the LayerZero docs.
As there are still room for improvement, this makes the code and the code documentation more user and developer friendly as possible, standardizing it according to the rest of the code and documentation design pattern from this repository.
Purpose:
@paramand@returnannotation tags in the EndpointV2.sol file, as well as code formatting, fix some misspelling and text, and also convert the comments from regular//format to NatSpec format, according to the other Solidity code files from the repository.Overview:
This patch follows my merged pull request from devtools, where I added a missing
@returnannotation tag to thequote()function on MyOApp.sol. This function is the same as thequote()function found on EndpointV2.sol. In addition to this function, other functions missing both@paramand@returnannotation tags were patched.All added annotation tags and descriptions were done based on similar annotation tags and descriptions of all contracts from this repository, as well as devtools and the LayerZero docs.
As there are still room for improvement, this makes the code and the code documentation more user and developer friendly as possible, standardizing it according to the rest of the code and documentation design pattern from this repository.