Skip to content

Are multi-line NatSpec comments read? #8

@KoenBal

Description

@KoenBal

It seems that the multi-line comment:

   /**
   * @dev Returns the amount of sellToken a user would need to exchange to receive buyAmount of
   * buyToken.
   * @param buyAmount The amount of buyToken the user would like to purchase.
   * @param sellGold `true` if gold is the sell token
   * @return The corresponding sellToken amount.
   */

is not read. As the descriptions are not available. Is it correct that only
/// style NatSpec comments are read?

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