API Documentation started

[Christian Stocker]

Hi out there

Documentation is not the most loved part by most programmers, but
nevertheless I started with some API-Documentation using JSDoc
(http://jsunit.berlios.de/internal.html), some derivate of javadoc.

Not much is documentated right now, but this will certainly change in
the near future, mostly because we are changing some of our code to use
more OO techniques.

You can see the API-Doc at
http://bitfluxeditor.org/api/

I hope, this will help people to get faster into the code of BXE.

chregu

[Christian Stocker]

Hi again

forgot something. This whole documentation will blow up the size of the
source code significantly, therefore we will provide a without-comments
release somewhen (when the docu gets too big, whenever that will be :) )

chregu

Post by Christian Stocker
Hi out there
Documentation is not the most loved part by most programmers, but
nevertheless I started with some API-Documentation using JSDoc
(http://jsunit.berlios.de/internal.html), some derivate of javadoc.
Not much is documentated right now, but this will certainly change in
the near future, mostly because we are changing some of our code to use
more OO techniques.
You can see the API-Doc at
http://bitfluxeditor.org/api/
I hope, this will help people to get faster into the code of BXE.
chregu

--
nam...christian stocker adr...bremgartnerstr. 66, ch-8003 zurich
pho...+41 1 451 6021 www...http://phant.ch/chregu
mob...[phone] ***@phant.ch
wor...+41 1 240 5670 gpg...0x5CE1DECB