search

meltingice / CamanJS

Javascript HTML5 (Ca)nvas (Man)ipulation
http://camanjs.com
BSD 3-Clause "New" or "Revised" License
3.55k stars 404 forks source link

http://camanjs.com/docs/caman.html isn't actually the API docs #87

Closed Pomax closed 11 years ago

Pomax commented 11 years ago

Usually one expects a list of functions that can be called in an API documentation link, but instead http://camanjs.com/docs/caman.html points to... something? A coffeescript file that doesn't seem related to caman.js at all, so I'm still left trying to figure out which functions actually exist that can be called on the Caman object =)

meltingice commented 11 years ago

That page is the annotated source of CamanJS, sorry for the name confusion. Have you checked out the guides at all?

I'll see what I can do to get a more accurate API representation up on the site.

Pomax commented 11 years ago

I have, but it's always good to have an API link with just the terse "these functions exist, they do so-and-so" if you just want to scan for that one function you're looking for but forgot the name of/signature for.

meltingice commented 11 years ago

Been making some progress in the apidocs branch. Not done yet, but hopefully it should help provide a better code reference.

Pomax commented 11 years ago

pretty sweet, although I am having a hard time with this API as an end user. It doesn't cover the calls that can be made on the page, instead being the dev code API. It might be a good idea to make the "API documentation" the "source code API", and adding a more prominent API button for what end users are looking for; which functions can be called on-page, what are their arguments, ordering, adding a filter in JS to extend caman's functions, etc.