Skip to content

Releases: OpenZeppelin/solidity-docgen

v0.5.16

05 Oct 23:42
Compare
Choose a tag to compare
  • Change handling of circular dependencies, fixing a potential issue with bad caching.

v0.5.15

05 Oct 22:52
Compare
Choose a tag to compare
  • Fix use of @inheritdoc in circularly dependent files.

v0.5.14

15 Sep 23:00
Compare
Choose a tag to compare
  • Add support for documenting structs and enums: {{structs}}, {{ownStructs}}, and likewise for enums. (#310)

v0.5.13

26 Apr 18:43
Compare
Choose a tag to compare
  • Fix a bug when parsing @custom NatSpec tags

v0.5.12

26 Apr 13:28
Compare
Choose a tag to compare
  • Add support for @custom: NatSpec tags.

v0.5.10

05 Dec 19:17
Compare
Choose a tag to compare

v0.5.9

18 Nov 20:41
Compare
Choose a tag to compare
  • Fix bug introduced in 0.5.8 for projects with dependencies.

v0.5.8

14 Nov 03:57
Compare
Choose a tag to compare
  • Fixed trimming of whitespace at the beginning of NatSpec lines.
  • Fixed issues with ignored newlines in solc >= 0.6.9.

This may change the output slightly for all users of solc >= 0.6. This shouldn't be an issue if the output format is Markdown.

v0.5.7

05 Oct 14:25
Compare
Choose a tag to compare
  • Fixed a bug that caused solidity-docgen to fail with solc >=0.7.1.

v0.5.6

04 Sep 23:28
Compare
Choose a tag to compare
  • Fixed a bug that prevented using solc 0.7 with the --solc-module option.

The built in compiler remains solc 0.6, but users who want to use the newer compiler version can do so by installing the desired solc version and using the flag --solc-module. Here's an example using npm aliases:

npm install -D solc-0.7@npm:solc@^0.7.0
npx solidity-docgen --solc-module solc-0.7