[documentation] Documenting js, ajax, aha API

Augustin beginner2005 at masquilier.org
Thu Dec 27 13:32:46 UTC 2007


Hello,

A while ago, I made a start at reorganizing the documentation related 
to javascript, and put all relevant pages into that section:
http://drupal.org/node/121997

Drupal is nice to develop for because it has a very well documented 
API (api.d.o.)

However, developing javascript and AHAH, Ajax is still a pain for me 
because I never know where to start. JQuery is well documented but 
not so drupal.js and the various core .js files.
There is no doxygen in the code nor the equivalent of api.d.o. for js.

I am trying to understand how book.js works, which leads me to 
drupal.js, etc... 

Since it has to be documented one day, I would like to start 
documenting as I am reading the code...

But the question is: where to do so? 

In the handbook?

In a separate file in the documentation project, that would appear at 
api.d.o?





-- 
Augustin
http://minguo.info/ better election methods
http://minguo.info/usa/ the USA FA/DP
Free Association with Delegable Proxy: an internet experiment in 
democracy. 




More information about the documentation mailing list