Skip to content

NatSpec @notice, @param and @dev for enums and structs #432

Description

@heueristik

It would be great if NatSpec @notice, @param and @dev comments on structs and enums would be available in the documentation.

For example, having

/// @notice Text.
/// @param a Text 1.
/// @param b Text 2.
struct ProposalParameters {
    bool a;
    uint256 b;
}

and documenting it with

{{natspec.notice}}

{{#if natspec.params}}
  | Member | Type | Description |
  |:------ | ---- | ----------- |
  {{#each params}}
    | {{name}} | {{type}} | {{natspec}} |
  {{/each}}
{{/if}}

I am aware of #413, but still unsure if this is possible by now or not because of insufficiencies of the solidity compiler.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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