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

Write classes' javadoc #33

Merged
merged 1 commit into from
Oct 3, 2017
Merged

Conversation

JordanMartinez
Copy link
Contributor

WIP

This should help new users understand how this project works.

@JordanMartinez
Copy link
Contributor Author

JordanMartinez commented Mar 30, 2017

All that's left to document is...

  • Navigator
  • MinDistanceTo

@JordanMartinez JordanMartinez force-pushed the addJavadoc branch 3 times, most recently from 7a0a1ad to 8898bd4 Compare March 31, 2017 01:14
@JordanMartinez
Copy link
Contributor Author

This is essentially finished (some methods in Navigator aren't documented, but I think people can understand how it works based on the class' javadoc and the methods that do have documentation). MinDistanceTo isn't documented, but I think the name speaks for itself when taken with Navigator's javadoc and the other implementations of TargetPosition

@JordanMartinez JordanMartinez mentioned this pull request Mar 31, 2017
@JordanMartinez JordanMartinez merged commit 0065080 into FXMisc:master Oct 3, 2017
@JordanMartinez JordanMartinez deleted the addJavadoc branch October 3, 2017 20:09
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.

None yet

1 participant