cerc-io/solidity
15
0
Fork 0
mirror of https://github.com/ethereum/solidity synced 2023-10-03 13:03:40 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update natspec

Browse Source
This commit is contained in:
chriseth 2019-12-12 16:53:15 +01:00
parent 0e2578dfc7
commit 6cdda54ce1
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/natspec-format.rst
View File

@ -84,7 +84,7 @@ Tag
``@notice`` Explain to an end user what this does contract, interface, function ``@notice`` Explain to an end user what this does contract, interface, function
``@dev`` Explain to a developer any extra details contract, interface, function ``@dev`` Explain to a developer any extra details contract, interface, function
``@param`` Documents a parameter just like in doxygen (must be followed by parameter name) function ``@param`` Documents a parameter just like in doxygen (must be followed by parameter name) function
``@return`` Documents the return type of a contract's function function ``@return`` Documents the return variables of a contract's function function
=========== =============================================================================== ============================= =========== =============================================================================== =============================
If your function returns multiple values, like ``(int quotient, int remainder)`` If your function returns multiple values, like ``(int quotient, int remainder)``