Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Abstract contracts not rendered #42

Open
SebastienGllmt opened this issue Jan 8, 2024 · 0 comments
Open

Abstract contracts not rendered #42

SebastienGllmt opened this issue Jan 8, 2024 · 0 comments

Comments

@SebastienGllmt
Copy link

SebastienGllmt commented Jan 8, 2024

If you have an abstract contract in your project, there is no documentation generated for any of it other than the top-level comment block for the contract (ex the title)

The readme of this project does say that

Due to the technical limitations of the Solidity compiler, the documentation of private and internal functions is not rendered. Hence, the documentation of libraries might be close to empty!

I'm not sure if abstract contracts fall under this scope as well, but abstract contract docgen does work in https://github.com/OpenZeppelin/solidity-docgen at least

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant