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

Adds @custom:.... natspec example to the natspec-format documentation.

Browse Source 
Co-authored-by: Harikrishnan Mulackal <webmail.hari@gmail.com>
This commit is contained in:
Christian Parpart 2021-03-24 17:09:42 +01:00
parent 4080748b1d
commit 10ec49ddb9
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/natspec-format.rst
View File

@ -60,12 +60,13 @@ The following example shows a contract and a function using all available tags.
.. code:: Solidity .. code:: Solidity
// SPDX-License-Identifier: GPL-3.0 // SPDX-License-Identifier: GPL-3.0
pragma solidity >=0.6.12 <0.9.0; pragma solidity >=0.8.2 < 0.9.0;
/// @title A simulator for trees /// @title A simulator for trees
/// @author Larry A. Gardner /// @author Larry A. Gardner
/// @notice You can use this contract for only the most basic simulation /// @notice You can use this contract for only the most basic simulation
/// @dev All function calls are currently implemented without side effects /// @dev All function calls are currently implemented without side effects
/// @custom:experimental This is an experimental contract.
contract Tree { contract Tree {
/// @notice Calculate tree age in years, rounded up, for live trees /// @notice Calculate tree age in years, rounded up, for live trees
/// @dev The Alexandr N. Tetearing algorithm could increase precision /// @dev The Alexandr N. Tetearing algorithm could increase precision
@ -236,6 +237,7 @@ file should also be produced and should look like this:
"kind" : "dev", "kind" : "dev",
"author" : "Larry A. Gardner", "author" : "Larry A. Gardner",
"details" : "All function calls are currently implemented without side effects", "details" : "All function calls are currently implemented without side effects",
"custom:experimental": "This is an experimental contract.",
"methods" : "methods" :
{ {
"age(uint256)" : "age(uint256)" :