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

Natspec not included getter functions #2795

Closed
simon-jentzsch opened this issue Aug 24, 2017 · 1 comment
Closed

Natspec not included getter functions #2795

simon-jentzsch opened this issue Aug 24, 2017 · 1 comment

Comments

@simon-jentzsch
Copy link

simon-jentzsch commented Aug 24, 2017

When adding natspec-comments in the code the resulting natspec-values will not report comments on any auto-generated function, since he is connecting the storage-comment with the function.
example:

contract C {
  /// @notice this comment does not appear in the generated getter-function, actually should.
  bytes32 public myPublicHash; 

  bytes32 myInternHash; 

  /// @notice this comment does appear in the generated documenation.
  function myHash() constant returns (bytes32) {
      return myInternHash;
   }
}
@axic axic changed the title natspec on generated functions Natspec not included getter functions Aug 24, 2017
@axic axic added the feature label Sep 18, 2017
@axic axic closed this as completed May 21, 2020
@axic
Copy link
Member

axic commented May 21, 2020

#3418 has more discussion on the same topic.

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

2 participants