<br><div class="gmail_quote">2012/10/29  <span dir="ltr"><<a href="mailto:VaclavKrpec@eaton.com" target="_blank">VaclavKrpec@eaton.com</a>></span><br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
Hello everybody,<br></blockquote><div><br>Hi Vasek<br> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
just a few notes to the doxygen X man issue:<br>
<br>
1/ AFAIK doxygen can generate man pages, so why don't<br>
   we just generate them and decide then whether they<br>
   are ill fitted or usable...<br>
<br>
2/ I'd definitely use doxygen when possible; I mean I don't<br>
   know any alternative that's able to do (at least partial)<br>
   validation of the documentation with the source<br>
<br>
3/ I have some experience with using doxygen for C++ code<br>
   documentation and must warn you that there may be a need<br>
   for some sacrifices; doxygen only does (quite poor) syntax<br>
   analysis and is more C-suited; with certain C++ constructs,<br>
   it fails quite flagrantly (at least the version I've used),<br>
   an example being instantiation of a static object with<br>
   global visibility scope, using constructor with arguments,<br>
   e.g. something like this:<br>
<br>
MyClass my_var(arg1, arg2);<br>
<br>
   doxygen misinterprets this as declaration of a function<br>
   and requires you to document the parameters (you need to<br>
   get rid of that using \cond and therefore you loose<br>
   the possibility of documenting the variable).<br>
   However, it's still the best I know.<br></blockquote><div><br>thanks for your comments.<br>we are still trying to evaluate the best tool for documenting source code.<br>Note that, as told, manpage are limited to C functions.<br>
<br>as you say, doxygen is probably the best of bread.<br>what would be very nice is a bridge between doxy and asciidoc... though I've not searched around that.<br>I see doxygen limited to documenting the core functions (for maintenance purposes) and client APIs.<br clear="all">
</div></div><br>cheers<br>Arnaud<br>-- <br>Linux / Unix / Opensource Engineering Expert - Eaton - <a href="http://opensource.eaton.com" target="_blank">http://opensource.eaton.com</a><br>Network UPS Tools (NUT) Project Leader - <a href="http://www.networkupstools.org" target="_blank">http://www.networkupstools.org</a><br>
Debian Developer - <a href="http://www.debian.org" target="_blank">http://www.debian.org</a><br>Free Software Developer - <a href="http://arnaud.quette.fr" target="_blank">http://arnaud.quette.fr</a><br><br>