Docs generator

Discussion about everything. New games, 3d math, development tips...
Post Reply
strale
Posts: 119
Joined: Wed Nov 23, 2005 1:58 pm
Location: Lambrugo Italy
Contact:

Docs generator

Post by strale »

Hi

sorry if this topic has been already discussed i did not find on a search.

i was wondering about what kind of doc generator are used by developpers :?: .

i experienced doxygen and i found great but sometimes it seems that it does not write all my coomments that i spoil all around my functions, (may bee my fault).

Thanks
vitek
Bug Slayer
Posts: 3919
Joined: Mon Jan 16, 2006 10:52 am
Location: Corvallis, OR

Post by vitek »

It is very likely your fault. You need to format your comments so that doxygen can process them. Once you get used to doing it, it is pretty easy.
3ddev
Posts: 169
Joined: Tue Sep 19, 2006 6:51 am
Contact:

Continue with doxygen!

Post by 3ddev »

Continue with doxygen! It is by far the best *free* doc compiler on the web. I tried many others before I used it. The learning curve is a bit steep, granted, but well worthwhile for the stunning output files! :lol:
strale
Posts: 119
Joined: Wed Nov 23, 2005 1:58 pm
Location: Lambrugo Italy
Contact:

Post by strale »

Thak you for the replay

also speking with some friends told me this is actually the best.

bye
EmmanuelD
Posts: 25
Joined: Thu Aug 24, 2006 8:34 am
Location: Right in front of Dagoth Ur
Contact:

Post by EmmanuelD »

Personnally, I find that NaturalDocs is also quite good. It lets you write comments that are not cluttered with strange symbols. Unfortunately, the C++ support is not completed yet, so you may find it less powerfull than doxygen.
-- Emmanuel D.
strale
Posts: 119
Joined: Wed Nov 23, 2005 1:58 pm
Location: Lambrugo Italy
Contact:

Post by strale »

Hi EmmanuelD

Thank you for the link , yesterdy i read a little the documentation
it seem appealing

if i do not mistake it could be used to document source not tagged
it could be very useful.
and the ouput generate is pleasant

it seem to have not a GUI/Wizzard :( but this is not a very problem
and also the loss of commands culd give some trouble as it use a style to format docs, so we must learn format style instead of commands.

thank
Post Reply