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

Expect a up-to-date API doc #39

Open
stuartZhang opened this issue Jan 10, 2017 · 4 comments
Open

Expect a up-to-date API doc #39

stuartZhang opened this issue Jan 10, 2017 · 4 comments

Comments

@stuartZhang
Copy link

Hello expert,

The existing API online documentation (http://sylvester.jcoglan.com/docs.html) is out of date. Therefore, the latest docs update is desirable.

@jcoglan
Copy link
Owner

jcoglan commented Jan 10, 2017

Can you be more specific about what you mean by "out of date"? The website reflects the last version of Sylvester I released.

@stuartZhang
Copy link
Author

I desire the API docs for the below JS Classes:

  1. Line.Segment
  2. Polygon
  3. Polygon.Vertex
  4. LinkedList
  5. LinkedList.Circular

@jcoglan
Copy link
Owner

jcoglan commented Jan 11, 2017

I never ended up releasing those classes, and the linked list implementation is not intended to be part of the public API. However I did begin writing some docs for them at the time, the source for which is here:

https://github.com/jcoglan/sylvester/tree/master/site/src/pages/api

@stuartZhang
Copy link
Author

Of them, I am fond of the Polygon class which is very useful to my vector-map project.

In addition, it's better to apply SIMD to the Vector and Matrix arithmetic in my perspective.

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

No branches or pull requests

2 participants