documenting Struct/ Enum/ Constant outside of contract

[ghost]

Hi, I'm attempting to document an EIP-2535 Diamond contract that utilizies an 'AppStorage' pattern such as in AAVEGotchi Thing is this pattern makes extensive use of structs outside of contracts. To which I cant seem to docgen to register it.

Is documenting structs outside of contracts possible, or if not, planned to be implemented?

Thanks!

[ghost]

specifically speaking

pragma solidity 0.8.9;
/**
* Some documentation about A
* @param b some documentation about
*/
struct A {
uint256 b;
}

contract FooBar {
...
}

[frangio]

Thanks for reaching out @Joe-mcgee. This is not currently supported. I'm interested in it but the code is structured around documenting contracts, and I haven't figure out how to implement it.

[ghost]

Thanks for looking into it and letting me know @frangio :)

[miltonjonat]

Hello there @frangio. I am also very interested in documenting structs outside of contracts. Are there any plans on that front nowadays? I am also unsure whether this depends on ethereum/solidity#12295 to be done first.

Cheers, and thanks for this great tool!

[frangio]

@miltonjonat This is technically supported in the 0.6 release.

Unfortunately as you point out the actual contents of the NatSpec will not show up, but the struct and enum data type definitely will show up in the produced docs.

[miltonjonat]

Ok @frangio thanks! Is there any open issue covering having NatSpec comments showing up in structs?

[frangio]

The issue is on the Solidity side. ethereum/solidity#12295