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 #11121 from ethereum/doc-natspec

Browse Source 
Document the version/kind fields in the natspec documentation
This commit is contained in:
chriseth 2021-03-17 17:25:48 +01:00 committed by GitHub
commit e179d0aa4d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/natspec-format.rst
View File

@ -177,6 +177,11 @@ documentation using:
And the output is below.
.. note::
Starting Solidity version 0.6.11 the NatSpec output also contains a ``version`` and a ``kind`` field.
Currently the ``version`` is set to ``1`` and ``kind`` must be one of ``user`` or ``dev``.
In the future it is possible that new versions will be introduced, deprecating older ones.
.. _header-user-doc:
User Documentation
@ -188,6 +193,8 @@ JSON file as output:
.. code::
{
"version" : 1,
"kind" : "user",
"methods" :
{
"age(uint256)" :
@ -214,6 +221,8 @@ file should also be produced and should look like this:
.. code::
{
"version" : 1,
"kind" : "dev",
"author" : "Larry A. Gardner",
"details" : "All function calls are currently implemented without side effects",
"methods" :