mirror of
https://github.com/ethereum/solidity
synced 2023-10-03 13:03:40 +00:00
Add NatSpec for public state variables
This commit is contained in:
parent
8a6540794a
commit
3e8b9bdb1c
@ -28,6 +28,9 @@ Documentation Example
|
||||
Documentation is inserted above each ``class``, ``interface`` and
|
||||
``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
|
||||
comments, or ``/**`` and ending with ``*/``.
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user