Skip to content

Handle Solidity NatSpec whitespace #32

@fulldecent

Description

@fulldecent

For a function specification like this:

/// @notice Perform initial contract setup
/// @dev    The initializer modifier ensures this is only called once, the owner should confirm this was properly
///         performed before publishing this contract address.
/// @param  _initialFee          fee to be paid on each sale, in basis points
/// @param  _initialFeeRecipient wallet to collets fees
/// @param  _initialPaymentToken address of the token that is used for settlement

I am hoping it can be parsed as:

Notice:

Perform initial contract setup

Dev:

The initializer modifier ensures this is only called once, the owner should confirm this was properly performed before publishing this contract address.

Param _initialFee:

fee to be paid on each sale, in basis points

Param _initialFeeRecipient :

wallet to collets fees

Param _initialPaymentToken :

address of the token that is used for settlement


Please let me know how this works and how I can help.

I am also the maintainer of the Solidity Style Guide and the Solidity NatSpec specification.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions