[Ctk-developers] Documentation of CMake macros and functions

[Jean-Christophe Fillion-Robin]

You rocks :)  +1

We should definitively create the project: commontk/CMakeDoxygenFilter

Do you think you could some sort of simple unit test.
This would :
 - allow  us to make sure the filter is working
 - provide people with an example

Should the project CMakeDoxygenFilter be an external project of CTK if
doxygen is installed on the machine ?

How doxygen can be extended ? Should the filter be added to the path ?
Installed ?

Thanks
Jc

On Tue, Apr 12, 2011 at 10:28 AM, Sascha Zelzer <s.zelzer at dkfz-heidelberg.de
> wrote:

> Hi Folks,
>
> 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).
>
> 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
> https://github.com/saschazelzer/CMakeDoxygenFilter/) and we are using it
> now in MITK. It allows you to document your CMake macros/functions inline
> using all of Doxygens commands.
>
> For example, it looks like this:
> http://docs.mitk.org/nightly-qt4/namespaceCMake.html#aed923b6189222cc8f9800cbc3486d7f5
> (we certainly still have a lot to do concerning the documentation of our
> macros... :-) )
>
> I would like to integrate this stuff into CTK, any comments/suggestions?
>
>
> Thanks,
>
> Sascha
> _______________________________________________
> Ctk-developers mailing list
> Ctk-developers at commontk.org
> http://public.kitware.com/cgi-bin/mailman/listinfo/ctk-developers
>



-- 
+1 919 869 8849
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://public.kitware.com/pipermail/ctk-developers/attachments/20110412/967892da/attachment.html>