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

Issue 99 documentation #159

Merged
merged 7 commits into from
Aug 24, 2020
Merged

Conversation

danwood
Copy link

@danwood danwood commented Aug 20, 2020

Description

I put in documentation comments for just about all structs, methods, etc. There are just a few pieces that I didn't mess with because I don't really have a good understanding of it to give a good explanation - maybe Andris can fill in the blanks? I really didn't get into Path+QuadCurve.swift for instance - the author will understand what is going on much more than I can. A few other pieces I couldn't figure out how to document - look for <#Description#> and <#content description#> in the code. (Still, everything builds fine, it could get merged in even with these pieces incomplete.)

Motivation and Context

See issue 99

How Has This Been Tested?

No code changes (except a couple of tweaks to make public/private consistency). It builds fine.

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Non-functional change (Updating Documentation, CI automation, etc..)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.

@AppPear
Copy link
Owner

AppPear commented Aug 24, 2020

awesome work i will also fill in some details

@AppPear AppPear merged commit 51db5a0 into AppPear:new-version Aug 24, 2020
@danwood danwood deleted the issue-99-documentation branch August 24, 2020 17:49
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