Enum NatSpecKind 

pub enum NatSpecKind {
    Title,
    Author,
    Notice,
    Dev,
    Param {
        name: Ident,
    },
    Return {
        name: Option<Ident>,
    },
    Inheritdoc {
        contract: Ident,
    },
    Custom {
        name: Ident,
    },
    Internal {
        tag: Ident,
    },
}

The kind of a NatSpecItem.

Reference: https://docs.soliditylang.org/en/latest/natspec-format.html#tags

Variants

Title

@title

A title that describes the contract.

Author

@author

The name of the author.

Notice

@notice

An annotation for end-users.

Dev

@dev

A technical annotation for developers.

Param

@param <name>

Documents a parameter. The name field contains the parameter name.

Fields

name: Ident

Return

@return <name>

Documents a return variable. The optional name field contains the return variable name.

Fields

name: Option<Ident>

Inheritdoc

@inheritdoc <contract>

Copies all tags from the base function. The contract field contains the contract name.

Fields

contract: Ident

Custom

@custom:<tag>

Custom tag with user-defined semantics. The name field contains the custom tag name.

Fields

name: Ident

Internal

@<tag>

Internal tags reserved for compiler purposes. The tag field contains the tag name.

Fields

tag: Ident

Trait Implementations

impl Clone for NatSpecKind

fn clone(&self) -> NatSpecKind

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for NatSpecKind

impl Debug for NatSpecKind

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Eq for NatSpecKind

impl PartialEq for NatSpecKind

fn eq(&self, other: &NatSpecKind) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for NatSpecKind