Add documentation for the Cadence documentation generator #1003
Conversation
This file contains 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
Codecov Report
@@ Coverage Diff @@
## master #1003 +/- ##
==========================================
+ Coverage 75.55% 75.58% +0.02%
==========================================
Files 267 267
Lines 32796 32885 +89
==========================================
+ Hits 24780 24856 +76
- Misses 6898 6908 +10
- Partials 1118 1121 +3
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
Co-authored-by: Joshua Hannan <[email protected]>
turbolent
reviewed
Jun 14, 2021
|
|
||
| ### Markdown Support | ||
| Standard Markdown format is supported in doc-comments, with a bit of Cadence flavour. | ||
| This means, any Markdown syntax used within the comments would be honoured and rendered like a standard Markdown snippet. |
Comment on lines
+54
to
+59
| /// This is the description of the function. This function adds two values. | ||
| /// | ||
| /// @param a: First integer value to add | ||
| /// @param b: Second integer value to add | ||
| /// @return Addition of the two arguments `a` and `b` | ||
| /// |
| pub fun add(a: Int, b: Int): Int { | ||
| } | ||
| ``` | ||
| - When documenting function parameters and return type, avoid mixing parameter/return-type documentations |
Co-authored-by: Bastian Müller <[email protected]>
SupunS
force-pushed
the
supun/doc-gen-docs
branch
from
1481837 to
433b131
Compare
turbolent
approved these changes
Jun 15, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
masterbranchFiles changedin the Github PR explorer