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 function docs formatting support #938

Merged
merged 2 commits into from
May 27, 2021
Merged

Add function docs formatting support #938

merged 2 commits into from
May 27, 2021

Conversation

SupunS
Copy link
Member

@SupunS SupunS commented May 24, 2021

Work towards #339

Description

Add function documentation formatting support.

  • Extracting param and return type info
    • Parameters must follow the format: @param paramName: Param description
    • Return type must follow the format: @return The return type description
    • Tagging using @ follows the same approach as solidity, kotlin and java
  • Removes leading and trailing whitespaces.
  • Preserves at most one blank line in the middle of docs in the generated md file.

  • Targeted PR against master branch
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work
  • Code follows the standards mentioned here
  • Updated relevant documentation
  • Re-reviewed Files changed in the Github PR explorer
  • Added appropriate labels

@SupunS SupunS requested a review from turbolent as a code owner May 24, 2021 04:24
@SupunS SupunS self-assigned this May 24, 2021
Copy link
Member

@turbolent turbolent left a comment

Choose a reason for hiding this comment

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

Nice!

Base automatically changed from supun/doc-gen-2 to master May 27, 2021 04:24
@codecov-commenter
Copy link

Codecov Report

Merging #938 (c5dc140) into master (1c06d00) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #938   +/-   ##
=======================================
  Coverage   74.05%   74.05%           
=======================================
  Files         269      269           
  Lines       33082    33082           
=======================================
  Hits        24500    24500           
  Misses       7453     7453           
  Partials     1129     1129           
Flag Coverage Δ
unittests 74.05% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1c06d00...c5dc140. Read the comment docs.

@SupunS SupunS merged commit bfcf914 into master May 27, 2021
@SupunS SupunS deleted the supun/doc-gen-3 branch May 27, 2021 04:46
@SupunS SupunS mentioned this pull request Jul 9, 2021
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants