This thread has no sense now that the offcial documentation has been released.
I wanted to start exploring the code tree, so i handed over Doxygen and generated a full documentation from the code. It turned to be more that 150Mb and quite messy, but noone said that learning the blender structure would be easy. I've put that docuemntation on-line in my web-page (my project web-page, as i don't have anything else) but only temporarily, as it takes a lot of space, from Sourceforge. The address is :
The code is not very prepared for Doxygen, but some comments are well extracted and also some nice graphs are built by dot. The main page of the documentation has an odd structure inserted instead of the title, but if you go and look at the indexes, the rest seems to be fair.
I suggest that the coding style/guidelines of the project are compatible with a documentation tool like Doxygen, or something else. Doxygen is not GPL i think, i don't know if this is problem.
Last edited by Bandoler on Sun Oct 20, 2002 9:26 pm; edited 1 time in total
We used Doxygen for the docs, but only for some parts where we needed it, or where it was very easy. Lots of little scraps are littered throughout the code. A few modules in src/blender are 'properly' documented, and several modules in intern/. I'm afraid it's not worth doxygenning everything, we never did that, and never intended that. It helps a lot, thoughj, so when you study some functions that are not documented, it's well worth the effort to put some lines of doxy-comments in. I thought Doxygen was GPL? Anyway, we combined it with lxr, bonsai, cvsweb and tindexbox, and that made a nice setup.
The Doxygen stuff nzc mentions is available at the Documention section of our site.