starjs icon indicating copy to clipboard operation
starjs copied to clipboard

StarJS reference

Open mourner opened this issue 14 years ago • 3 comments

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.

mourner avatar Aug 26 '11 09:08 mourner

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

monoid avatar Aug 26 '11 09:08 monoid

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

monoid avatar Aug 26 '11 09:08 monoid

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.

mourner avatar Aug 26 '11 09:08 mourner