lintspec 0.12.2

A blazingly fast linter for NatSpec comments in Solidity code
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

// SPDX-License-Identifier: MIT
pragma solidity =0.8.19;

/// @title The interface
interface IInterfacedSample {
    /**
     * @notice Greets the caller
     *
     * @return _balance  Current token balance of the caller
     */
    function greet() external view returns (string memory _greeting, uint256 _balance);
}

contract InterfacedSample is IInterfacedSample {
    /// @dev some dev thingy
    function greet() external view returns (string memory _greeting, uint256 _balance) {}
}