Code documentation on-line

Blender documentation projects, tutorials, translation, learning & teaching Blender

Moderators: jesterKing, stiv

Bandoler
Posts: 53
Joined: Mon Oct 14, 2002 3:16 pm
Location: Somewhere between the 1 and the 0

Code documentation on-line

Postby Bandoler » Wed Oct 16, 2002 5:50 pm

This thread has no sense now that the offcial documentation has been released.

---DEPRECATED
Hello,
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 :

http://prospectus.sf.net/blender/html/index.html

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.

Bandoler!.
Last edited by Bandoler on Sun Oct 20, 2002 10:26 pm, edited 1 time in total.

nzc
Posts: 3
Joined: Wed Oct 16, 2002 11:16 pm

Postby nzc » Wed Oct 16, 2002 11:25 pm

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.

k-fish
Posts: 23
Joined: Tue Oct 15, 2002 11:28 pm
Location: Braunschweig, Germany
Contact:

Postby k-fish » Thu Oct 17, 2002 1:29 pm

nzc wrote:I thought Doxygen was GPL? Anyway, we combined it with lxr, bonsai, cvsweb and tindexbox, and that made a nice setup.


Just had a look, it is GPL. No need to worry about that. That documentation system you built, will it be available on blender.org in some way or the other?

henoheno
Posts: 1
Joined: Wed Oct 16, 2002 3:41 pm

Yet another? CVSweb

Postby henoheno » Sun Oct 20, 2002 6:54 pm

Hi.
If there's no official WWW interface of CVS repository yet, this maybe helpful.

There's testing knit of blender two repositories into one (I knit test02 just now :-)).
http://minix-up.sourceforge.jp/cgi-bin/l.cgi/
http://minix-up.sourceforge.jp/cgi-bin/ ... R_225b_ODE
http://minix-up.sourceforge.jp/cgi-bin/ ... web-markup

And you can verify these knits here.
http://minix-up.sourceforge.jp/_BLENDERtest/

Enjoy!

ton
Site Admin
Posts: 525
Joined: Wed Oct 16, 2002 12:13 am
Contact:

Postby ton » Sun Oct 20, 2002 6:59 pm

The Doxygen stuff nzc mentions is available at the Documention section of our site.

Bandoler
Posts: 53
Joined: Mon Oct 14, 2002 3:16 pm
Location: Somewhere between the 1 and the 0

Postby Bandoler » Sun Oct 20, 2002 10:22 pm

ton wrote:The Doxygen stuff nzc mentions is available at the Documention section of our site.


Great. Things are going at a very good rythm. Good job. I'll remove all that autogenerated stuff from my page.

Bandoler


Return to “Documentation & Education”

Who is online

Users browsing this forum: Yahoo [Bot] and 0 guests