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

doc common: Draft documentation for C++ header APIs #348

Merged
merged 1 commit into from
Apr 21, 2021
Merged

Conversation

JSUYA
Copy link
Member

@JSUYA JSUYA commented Apr 15, 2021

  • Description :
    Write documentation for some of the APIs that have already been cleared up.

  • Issue Tickets (if any) :
    API Documentation  #27

@JSUYA JSUYA marked this pull request as draft April 15, 2021 09:35
@github-actions
Copy link

CODING STYLE CHECK:

thorvg.h:133:  public: should be indented +1 space inside class Paint  [whitespace/indent] [3]
thorvg.h:217:  public: should be indented +1 space inside class Fill  [whitespace/indent] [3]
thorvg.h:278:  public: should be indented +1 space inside class Canvas  [whitespace/indent] [3]
thorvg.h:322:  public: should be indented +1 space inside class final  [whitespace/indent] [3]
thorvg.h:354:  public: should be indented +1 space inside class final  [whitespace/indent] [3]
thorvg.h:388:  public: should be indented +1 space inside class final  [whitespace/indent] [3]
thorvg.h:645:  public: should be indented +1 space inside class final  [whitespace/indent] [3]
thorvg.h:703:  public: should be indented +1 space inside class final  [whitespace/indent] [3]
thorvg.h:740:  public: should be indented +1 space inside class final  [whitespace/indent] [3]
thorvg.h:772:  public: should be indented +1 space inside class final  [whitespace/indent] [3]
thorvg.h:800:  public: should be indented +1 space inside class final  [whitespace/indent] [3]
thorvg.h:801:  Do not leave a blank line after "public:"  [whitespace/blank_line] [3]
Done processing thorvg.h
Total errors found: 12

@hermet hermet added the documentation Improvements / Additions to documentation label Apr 15, 2021
@github-actions
Copy link

CODING STYLE CHECK:

thorvg.h:133:  public: should be indented +1 space inside class Paint  [whitespace/indent] [3]
thorvg.h:217:  public: should be indented +1 space inside class Fill  [whitespace/indent] [3]
thorvg.h:278:  public: should be indented +1 space inside class Canvas  [whitespace/indent] [3]
thorvg.h:322:  public: should be indented +1 space inside class final  [whitespace/indent] [3]
thorvg.h:354:  public: should be indented +1 space inside class final  [whitespace/indent] [3]
thorvg.h:388:  public: should be indented +1 space inside class final  [whitespace/indent] [3]
thorvg.h:645:  public: should be indented +1 space inside class final  [whitespace/indent] [3]
thorvg.h:703:  public: should be indented +1 space inside class final  [whitespace/indent] [3]
thorvg.h:740:  public: should be indented +1 space inside class final  [whitespace/indent] [3]
thorvg.h:772:  public: should be indented +1 space inside class final  [whitespace/indent] [3]
thorvg.h:800:  public: should be indented +1 space inside class final  [whitespace/indent] [3]
thorvg.h:801:  Do not leave a blank line after "public:"  [whitespace/blank_line] [3]
Done processing thorvg.h
Total errors found: 12

@JSUYA JSUYA marked this pull request as ready for review April 21, 2021 05:33
@github-actions
Copy link

CODING STYLE CHECK:

thorvg.h:133:  public: should be indented +1 space inside class Paint  [whitespace/indent] [3]
thorvg.h:217:  public: should be indented +1 space inside class Fill  [whitespace/indent] [3]
thorvg.h:278:  public: should be indented +1 space inside class Canvas  [whitespace/indent] [3]
thorvg.h:322:  public: should be indented +1 space inside class final  [whitespace/indent] [3]
thorvg.h:354:  public: should be indented +1 space inside class final  [whitespace/indent] [3]
thorvg.h:388:  public: should be indented +1 space inside class final  [whitespace/indent] [3]
thorvg.h:645:  public: should be indented +1 space inside class final  [whitespace/indent] [3]
thorvg.h:703:  public: should be indented +1 space inside class final  [whitespace/indent] [3]
thorvg.h:740:  public: should be indented +1 space inside class final  [whitespace/indent] [3]
thorvg.h:772:  public: should be indented +1 space inside class final  [whitespace/indent] [3]
thorvg.h:800:  public: should be indented +1 space inside class final  [whitespace/indent] [3]
Done processing thorvg.h
Total errors found: 11

Write documentation for some of the APIs that have already been cleared up.
@github-actions
Copy link

CODING STYLE CHECK:

thorvg.h:133:  public: should be indented +1 space inside class Paint  [whitespace/indent] [3]
thorvg.h:217:  public: should be indented +1 space inside class Fill  [whitespace/indent] [3]
thorvg.h:278:  public: should be indented +1 space inside class Canvas  [whitespace/indent] [3]
thorvg.h:322:  public: should be indented +1 space inside class final  [whitespace/indent] [3]
thorvg.h:354:  public: should be indented +1 space inside class final  [whitespace/indent] [3]
thorvg.h:388:  public: should be indented +1 space inside class final  [whitespace/indent] [3]
thorvg.h:645:  public: should be indented +1 space inside class final  [whitespace/indent] [3]
thorvg.h:703:  public: should be indented +1 space inside class final  [whitespace/indent] [3]
thorvg.h:740:  public: should be indented +1 space inside class final  [whitespace/indent] [3]
thorvg.h:772:  public: should be indented +1 space inside class final  [whitespace/indent] [3]
thorvg.h:800:  public: should be indented +1 space inside class final  [whitespace/indent] [3]
Done processing thorvg.h
Total errors found: 11

@hermet hermet requested a review from mgrudzinska April 21, 2021 07:55
@hermet
Copy link
Member

hermet commented Apr 21, 2021

@mgrudzinska please have a look this patch & contribute additional patches for the unsatisfied stuff.

@mgrudzinska
Copy link
Collaborator

@hermet sure! I'll do it

@hermet hermet merged commit 2cfc2bd into master Apr 21, 2021
@JSUYA JSUYA deleted the devs/jsuya/docs branch April 21, 2021 08:58
@JSUYA JSUYA mentioned this pull request Apr 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements / Additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants