natspec function

lucycodes42

The code explains to an end user what it does, and also provides extra details for developers. It takes a document as a parameter, just like in doxygen, and returns the document's parameters.

Shortcut: nat_function

/// @notice Explain to an end user what this does
/// @dev Explain to a developer any extra details
/// @param Documents a parameter just like in doxygen (must be followed by parameter name)
/// @return Documents the return variables of a contract’s function state variable
/// @inheritdoc  Copies all missing tags from the base function (must be followed by the contract name)