https://github.com/joincolony/natspec-typedoc

Create typedoc compatible comments from NatSpec comments
https://github.com/joincolony/natspec-typedoc

natspec solidity typedoc

Last synced: 21 days ago
JSON representation

Create typedoc compatible comments from NatSpec comments

• Host: GitHub
• URL: https://github.com/joincolony/natspec-typedoc
• Owner: JoinColony
• License: gpl-3.0
• Created: 2020-04-07T15:20:42.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2020-10-28T16:58:31.000Z (over 5 years ago)
• Last Synced: 2025-06-21T00:40:38.125Z (12 months ago)
• Topics: natspec, solidity, typedoc
• Language: TypeScript
• Size: 27.3 KB
• Stars: 1
• Watchers: 4
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# natspec-typedoc

## What?

Create typedoc compatible comments from NatSpec comments

Turns this

https://solidity.readthedocs.io/en/v0.5.8/natspec-format.html

into this

https://typedoc.org/guides/doccomments

That's it.

## License

MIT