JoinColony / natspec-typedoc Public

Notifications You must be signed in to change notification settings
Fork 0
Star 1

Create typedoc compatible comments from NatSpec comments

GPL-3.0 license

1 star 0 forks Branches Tags Activity

Notifications

Name		Name	Last commit message	Last commit date
Latest commit History 9 Commits
.github/workflows		.github/workflows
src		src
.gitignore		.gitignore
.nvmrc		.nvmrc
.prettierrc		.prettierrc
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
LICENSE		LICENSE
README.md		README.md
package-lock.json		package-lock.json
package.json		package.json
renovate.json		renovate.json
tsconfig.json		tsconfig.json

Repository files navigation

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