Migrate to inheritdoc

[vittominacori]

Fixes #5563

I migrated simple Natspec comments to use @inheritdoc.

For instance:

/**
- * @dev See {IERC165-supportsInterface}.
+ * @inheritdoc IERC165
*/
function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
    // ...
}

I would like to get your feedback about more complex comments like:

/**
 * @dev See {IERC20-transferFrom}.
 *
 * Skips emitting an {Approval} event indicating an allowance update. This is not
 * required by the ERC. See {xref-ERC20-_approve-address-address-uint256-bool-}[_approve].
 *
 * NOTE: Does not update the allowance if the current allowance
 * is the maximum `uint256`.
 *
 * Requirements:
 *
 * - `from` and `to` cannot be the zero address.
 * - `from` must have a balance of at least `value`.
 * - the caller must have allowance for ``from``'s tokens of at least
 * `value`.
 */
function transferFrom(address from, address to, uint256 value) public virtual returns (bool) {
    address spender = _msgSender();
    _spendAllowance(from, spender, value);
    _transfer(from, to, value);
    return true;
}

Do you suggest to use the @notice spec for custom comments:

/**
 * @inheritdoc IERC20
 * @notice Skips emitting an {Approval} event indicating an allowance update. This is not
 * required by the ERC. See {xref-ERC20-_approve-address-address-uint256-bool-}[_approve].
 *
 * NOTE: Does not update the allowance if the current allowance
 * is the maximum `uint256`.
 *
 * Requirements:
 *
 * - `from` and `to` cannot be the zero address.
 * - `from` must have a balance of at least `value`.
 * - the caller must have allowance for ``from``'s tokens of at least
 * `value`.
 */

Or do you suggest using @custom specification like:

/**
 * @inheritdoc IERC20
 * @notice Skips emitting an {Approval} event indicating an allowance update. This is not
 * required by the ERC. See {xref-ERC20-_approve-address-address-uint256-bool-}[_approve].
 *
 * @custom:note Does not update the allowance if the current allowance is the maximum `uint256`.
 *
 * @custom:requirements
 * - `from` and `to` cannot be the zero address.
 * - `from` must have a balance of at least `value`.
 * - the caller must have allowance for ``from``'s tokens of at least
 * `value`.
 */

[changeset-bot]

⚠️ No Changeset found

Latest commit: 008b674

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR