Developer forums (C::B DEVELOPMENT STRICTLY!) > Development

Documentation Software

(1/3) > >>

Archangel-Tyrael:
With KDevelop having doxygen in the package, i think it would be "neat" to have a documentation software come along codeblock's default installation package

The most popular documentation software are

-doxygen(used by kdevelop)
Support for c/c++,java,python and partially php
Not so proffesional look(personally i find its "default" presentation annoying to read)
written in c/c++

-Doxys
Support for c/c++ only
Very proffesional look
fork of doxygen thus written in c/c++(i saw some python scripts too..)

-Natural Docs
Support for many languages and easilly expandible
Really Neat "natural"  Documentation style
Proffesional look but i dont think it would look as good in chm?
Written in perl...(thus need of perl interpreter...)
Has differential building( if you run Natural Docs on the same source tree, same command line options, and without changing configuration file,it will only update the files that have changed,which is very helpfull compared to full recompiles of the other two)

I prefer Natural Docs, though i guess the requirement of perl interpreter and (the already buildin) documentation highlighting of doxys&doxygen would possibly make doxys a better canditate?

takeshimiya:
Doxygen: I never liked the output produced, it's very user unfriendly.

Doxys: I like a lot the output produced by it. So much that I've made the SDK reference with it here: http://forums.codeblocks.org/index.php?topic=1358.0

Natural Docs: I like a lot the "natural" style of writting for, I think it's the best approach, but for me perl==no, so I don't know how the output looks.

Michael:
Hello,

In my experience, Doxygen is oft used by developers for Academic and Industrial domain. In every project, I have participated Doxygen was used (more or less), even if it was not a mandatory requirement. Personally, the output is not very easy to understand :(.

Concerning Doxys no idea. I never tried it.

Natural Docs sounds good, but regarding Perl, I would say no thank you. I use scripts only when I absolutly have. But this is me :).

Michael

yop:

--- Quote from: Michael on December 20, 2005, 12:17:06 pm ---Concerning Doxys no idea. I never tried it.

--- End quote ---
You can get the cb sdk documentation generated by DoxyS that Takeshi Miya built from the link in his post. I never heard of Doxys before but following his howto I built the sdk documentation and now I can't work without it (I have also loaded it to the help plugin and I get a search in documentaion right click entry, how great is that?). The output IMHO is by far better that Doxygen.

thomas:
What is documentation?

Navigation

[0] Message Index

[#] Next page