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

StarJS reference #1

Open
mourner opened this issue Aug 26, 2011 · 3 comments
Open

StarJS reference #1

mourner opened this issue Aug 26, 2011 · 3 comments

Comments

@mourner
Copy link

mourner commented Aug 26, 2011

StarJS lacks documentation, source comments are not enough. You can describe all the methods in the GitHub wiki for example.

Also some examples would be helpful.

@monoid
Copy link
Owner

monoid commented Aug 26, 2011

That's true, but meantime 'Astronomy on the Personal Computer' can be used as guide, as API is quite similar.

@monoid
Copy link
Owner

monoid commented Aug 26, 2011

I planned to use JavaDoc-like documentation, but still don't know good tool for it.

@mourner
Copy link
Author

mourner commented Aug 26, 2011

In my experience, doc generation tools just suck. They're just too limited and you don't get a very usable and readable documentation as an output. Wiki, Markdown or plain HTML is MUCH better.

@monoid monoid mentioned this issue Nov 17, 2021
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