Add NatSpec for public state variables

ethereum · May 19, 2020 · 3e8b9bd · 3e8b9bd
1 parent 8a65407
commit 3e8b9bd
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/docs/natspec-format.rst b/docs/natspec-format.rst
@@ -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 ``*/``.