Add JSON/MD documentation of protocol smart contracts - #78
Merged
Conversation
3 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This adds basic JSON and MD of protocol contracts, generated using the
solc --devdocoption. 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:
devdocgives 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 bydevdoc.