Documentation: Doxygen or qdoc (split out of: New SimpleCrypt page)
-
wrote on 20 Mar 2011, 21:48 last edited by
[I've split this discussion about documentation tools out of the original thread "New SimpleCrypt page":http://developer.qt.nokia.com/forums/viewthread/4565/, Volker]
Andre, do you document your code using doxygen?
I am not sure to continue (I document too with doxygen) or leave, because it seems that whose people that don't use doxygen have difficulties to read comments in the code without the doxy reinterpretation.
-
wrote on 21 Mar 2011, 06:24 last edited by
[quote author="Alicemirror" date="1300657701"]Andre, do you document your code using doxygen?
I am not sure to continue (I document too with doxygen) or leave, because it seems that whose people that don't use doxygen have difficulties to read comments in the code without the doxy reinterpretation.[/quote]
I do, yes. I never noticed problems in readability of the comments, though I don't use doxygen to the max. When writing stuff that I'd like to see in Qt proper, I use qdoc, of course, but that is close to doxygen (in fact, I believe doxygen was based on qdoc once upon a time, but I don't know that for sure.)
Are there viable alternatives?
-
wrote on 21 Mar 2011, 08:02 last edited by
Hi,
no I think that there aren't other alternatives. The only thing I found different from doxygen is a simila way called LinuDox, that as a matter is used only to document linux kernel development (I used it in embedded systems) The fact is that in these cases doxygen is unusable because there are too many exceptions. Then this method is used in all ther kernelsI have seen and the advantage is that with any toolchain the kernel is distributed with the updated documentation itself.
Interesting is qdoc, that I don't know at all. Is a Doxygen-like documentation method included in Qt ? I have several projects that at this point needs to have a documentation inside, so I am unsure if update them with doxy or other.
Thanks.
-
wrote on 21 Mar 2011, 08:09 last edited by
Yes, qdoc is similar the doxygen. It is used to document the Qt sources. The Qt documentation is generated with it. Google, and you will find ;-)
-
wrote on 21 Mar 2011, 08:17 last edited by
Great! Many thanks Andre, I check now immediately.
-
wrote on 21 Mar 2011, 08:51 last edited by
Mmmh, It seems that is for ms windows only, is it true? Then, everywhere on the net qdoc or qdoc documentation tool report all the pages to a site that describe this tool as a database documenter with facilities for graphs and data representation. Very strange.
-
wrote on 21 Mar 2011, 09:07 last edited by
[quote author="Alicemirror" date="1300697505"]Mmmh, It seems that is for ms windows only, is it true? Then, everywhere on the net qdoc or qdoc documentation tool report all the pages to a site that describe this tool as a database documenter with facilities for graphs and data representation. Very strange.[/quote]
No, it is not only of windows. See http://doc.qt.nokia.com/qdoc/ (though that site behaves a bit strangely for me at the moment).
-
wrote on 21 Mar 2011, 09:17 last edited by
Ah, ok, so it is the right site. I found it but seeing the text-only pages I thought that it was a wrong link. It seems that these pages have no stylesheet on them at all... I try later. Thanks.
3/8