search

onflow / cadence-tools

Developer tools for Cadence
https://www.onflow.org/
Apache License 2.0
24 stars 20 forks source link

[DocGen] Resource function comments not being fully generated #41

Open alilloig opened 1 year ago

alilloig commented 1 year ago

Issue to be solved

At a resource that has more than one function, the comments for the second and further functions are not fully generated (they do not include the description and the param/return section)

e.g.: source code -> https://github.com/onflow/flow-nft/blob/f8d716eb98c8d8eee1f45efb3eeaf01831312192/contracts/NonFungibleToken.cdc#L163 generated doc -> https://github.com/onflow/flow-nft/blob/default-implenentations/docs/NonFungibleToken/NonFungibleToken_Collection.md

turbolent commented 1 year ago

This should be fixed by onflow/cadence#2302 and onflow/cadence#2303.

TODO: verify once the docgen tool got updated