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

Add NatSpec for public state variables

Browse Source
This commit is contained in:
William Entriken 2019-12-02 10:40:04 -05:00 committed by Alexander Arlt
parent 8a6540794a
commit 3e8b9bdb1c
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/natspec-format.rst
View File

@ -28,6 +28,9 @@ Documentation Example
Documentation is inserted above each ``class``, ``interface`` and Documentation is inserted above each ``class``, ``interface`` and
``function`` using the doxygen notation format. ``function`` using the doxygen notation format.
Note: a ``public`` state variable is equivalent to a ``function``
for the purposes of NatSpec.
- For Solidity you may choose ``///`` for single or multi-line - For Solidity you may choose ``///`` for single or multi-line
comments, or ``/**`` and ending with ``*/``. comments, or ``/**`` and ending with ``*/``.