Questions tagged [natspec]

In Solidity, Natural Language Specification Format (NatSpec) is a special form of comments to provide rich documentation for functions, return variables and more.

Filter by
Sorted by
Tagged with
1
vote
0answers
143 views

DocstringParsingError when using natspec with internal or private functions

Ethereum's natspec mentions: You are welcome to use similar comments for your internal and private functions, but those will not be parsed. However, when documenting internal functions, I get ...
4
votes
1answer
81 views

Is Natspec still used?

Is the natural specification format a real standard, or a mostly unused tool? I wonder if it is worth natspeccing my programs.
0
votes
2answers
551 views

Convert natspec into human readable document

How do I convert Natspec into something that a human can easily read? Eg: HTML, Markdown, .PDF