Allow NatSpec to apply to Libraries just as Contracts

ethereum · May 14, 2021 · b2ef1a4 · b2ef1a4
1 parent 324caef
commit b2ef1a4
Showing 1 changed file with 4 additions and 4 deletions.
diff --git a/docs/natspec-format.rst b/docs/natspec-format.rst
@@ -115,10 +115,10 @@ in the same way as if it were tagged with ``@notice``.
 =============== ====================================================================================== =============================
 Tag                                                                                                    Context
 =============== ====================================================================================== =============================
-``@title``      A title that should describe the contract/interface                                    contract, interface
-``@author``     The name of the author                                                                 contract, interface
-``@notice``     Explain to an end user what this does                                                  contract, interface, function, public state variable, event
-``@dev``        Explain to a developer any extra details                                               contract, interface, function, state variable, event
+``@title``      A title that should describe the contract/interface                                    contract, library, interface
+``@author``     The name of the author                                                                 contract, library, interface
+``@notice``     Explain to an end user what this does                                                  contract, library, interface, function, public state variable, event
+``@dev``        Explain to a developer any extra details                                               contract, library, interface, function, state variable, event
 ``@param``      Documents a parameter just like in Doxygen (must be followed by parameter name)        function, event
 ``@return``     Documents the return variables of a contract's function                                function, public state variable
 ``@inheritdoc`` Copies all missing tags from the base function (must be followed by the contract name) function, public state variable