[Ctk-developers] Documentation of CMake macros and functions

Mon May 2 12:04:10 EDT 2011

Work out of the box on my machine. Looks great !

I have no excuse now .. will have to document the macro / function I wrote
:)

Thanks
Jc

On Fri, Apr 29, 2011 at 10:26 AM, Sascha Zelzer <s.zelzer at dkfz-heidelberg.de
> wrote:

> Hi,
>
> I just pushed the necessary changes for having CMake macros documented via
> Doxygen. You should be able to have a look at the doxygen output tomorrow,
> when the documentation has been regenerated.
>
> Feel free to start writing outstanding documentation of your CMake code ;-)
>
> - Sascha
>
>
> On 04/12/2011 04:28 PM, Sascha Zelzer 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
>>
>
> _______________________________________________
> 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/20110502/fa6c8e27/attachment.html>