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

Merge pull request #11394 from fulldecent/patch-21

Browse Source 
Allow NatSpec to apply to Libraries just as Contracts
This commit is contained in:
Harikrishnan Mulackal 2021-05-17 12:30:45 +02:00 committed by GitHub
commit 55506418bc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
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
=============== ====================================================================================== =============================
``@title`` A title that should describe the contract/interface contract, interface
``@author`` The name of the author contract, interface
``@notice`` Explain to an end user what this does contract, interface, function, public state variable, event
``@dev`` Explain to a developer any extra details contract, interface, function, state variable, event
``@title`` A title that should describe the contract/interface contract, library, interface
``@author`` The name of the author contract, library, interface
``@notice`` Explain to an end user what this does contract, library, interface, function, public state variable, event
``@dev`` Explain to a developer any extra details contract, library, interface, function, state variable, 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
``@inheritdoc`` Copies all missing tags from the base function (must be followed by the contract name) function, public state variable