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

Add JSON/MD documentation of protocol smart contracts #78

Merged
merged 1 commit into from
Dec 21, 2017

Conversation

jasonklein
Copy link
Contributor

This adds basic JSON and MD of protocol contracts, generated using the solc --devdoc option. The natspec documentation that was used to generate these docs is not included in this PR, because while much of our documentation is formatted for readability, manipulations/massaging was required to make the natspec documentation readable in JSON/MD, in addition to other adjustments. So, the in-line documentation will need to be updated in a separate issue (along with the addition of the scripts used to produce these files).

Note: devdoc gives the parameters back in alphabetical order, not the order in which they appear in the signature, so for now it was more sensible to write the order out as part of the detail of each function rather than to display the params object as is provided by devdoc.

Copy link
Contributor

@benjaminbollen benjaminbollen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@benjaminbollen benjaminbollen merged commit e938fc0 into release-0.9 Dec 21, 2017
@benjaminbollen benjaminbollen deleted the jasonbanks/gh34/add-contract-docs branch June 4, 2018 14:30
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

Successfully merging this pull request may close these issues.

2 participants