You rocks :) +1 <br><br>We should definitively create the project: commontk/CMakeDoxygenFilter<br><br>Do you think you could some sort of simple unit test. <br>This would :<br> - allow us to make sure the filter is working<br>
- provide people with an example<br><br>Should the project CMakeDoxygenFilter be an external project of CTK if doxygen is installed on the machine ? <br><br>How doxygen can be extended ? Should the filter be added to the path ? Installed ? <br>
<br>Thanks<br>Jc<br><br><div class="gmail_quote">On Tue, Apr 12, 2011 at 10:28 AM, Sascha Zelzer <span dir="ltr"><<a href="mailto:s.zelzer@dkfz-heidelberg.de">s.zelzer@dkfz-heidelberg.de</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin: 0pt 0pt 0pt 0.8ex; border-left: 1px solid rgb(204, 204, 204); padding-left: 1ex;">
Hi Folks,<br>
<br>
I have always been a little bit annoyed by the lack of documentation for custom CMake macros and functions (both in our own projects and in CTK).<br>
<br>
Doxygen supports the idea of so called "input filters" which take an input file and transform it into code which Doxygen can understand and parse. I wrote such an input filter for CMake files (see <a href="https://github.com/saschazelzer/CMakeDoxygenFilter/" target="_blank">https://github.com/saschazelzer/CMakeDoxygenFilter/</a>) and we are using it now in MITK. It allows you to document your CMake macros/functions inline using all of Doxygens commands.<br>
<br>
For example, it looks like this: <a href="http://docs.mitk.org/nightly-qt4/namespaceCMake.html#aed923b6189222cc8f9800cbc3486d7f5" target="_blank">http://docs.mitk.org/nightly-qt4/namespaceCMake.html#aed923b6189222cc8f9800cbc3486d7f5</a><br>
(we certainly still have a lot to do concerning the documentation of our macros... :-) )<br>
<br>
I would like to integrate this stuff into CTK, any comments/suggestions?<br>
<br>
<br>
Thanks,<br>
<br>
Sascha<br>
_______________________________________________<br>
Ctk-developers mailing list<br>
<a href="mailto:Ctk-developers@commontk.org" target="_blank">Ctk-developers@commontk.org</a><br>
<a href="http://public.kitware.com/cgi-bin/mailman/listinfo/ctk-developers" target="_blank">http://public.kitware.com/cgi-bin/mailman/listinfo/ctk-developers</a><br>
</blockquote></div><br><br clear="all"><br>-- <br>+1 919 869 8849<br><br>