cerc-io/solidity
16
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-format.rst

Browse Source
This commit is contained in:
Aditya Kode 2023-05-24 21:43:56 +05:30 committed by Kamil Śliwak
parent 9bce5f91dc
commit 1a1ae5d99e
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/natspec-format.rst
View File

@ -115,10 +115,10 @@ in the same way as if it were tagged with ``@notice``.
=============== ====================================================================================== ============================= =============== ====================================================================================== =============================
Tag Context Tag Context
=============== ====================================================================================== ============================= =============== ====================================================================================== =============================
``@title`` A title that should describe the contract/interface contract, library, interface ``@title`` A title that should describe the contract/interface contract, library, interface, structs, enums
``@author`` The name of the author contract, library, interface ``@author`` The name of the author contract, library, interface, structs, enums
``@notice`` Explain to an end user what this does contract, library, interface, function, public state variable, event ``@notice`` Explain to an end user what this does contract, library, interface, function, public state variable, event, structs, enums
``@dev`` Explain to a developer any extra details contract, library, interface, function, state variable, event ``@dev`` Explain to a developer any extra details contract, library, interface, function, state variable, event, structs, enums
``@param`` Documents a parameter just like in Doxygen (must be followed by parameter name) function, event ``@param`` Documents a parameter just like in Doxygen (must be followed by parameter name) function, event
``@return`` Documents the return variables of a contract's function function, public state variable ``@return`` Documents the return variables of a contract's function function, public state variable
``@inheritdoc`` Copies all missing tags from the base function (must be followed by the contract name) function, public state variable ``@inheritdoc`` Copies all missing tags from the base function (must be followed by the contract name) function, public state variable