<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta content="text/html; charset=ISO-8859-1"
http-equiv="Content-Type">
</head>
<body text="#000000" bgcolor="#ffffff">
On 04/12/2011 04:39 PM, Jean-Christophe Fillion-Robin wrote:
<blockquote
cite="mid:BANLkTikdxfLLjmzzLGo60i4FnFDWHK6MXw@mail.gmail.com"
type="cite">You rocks :) +1 <br>
<br>
We should definitively create the project:
commontk/CMakeDoxygenFilter<br>
</blockquote>
<br>
Yes, we could do that. But we will probably not need a direct
dependency to it (see comments below).<br>
<br>
<blockquote
cite="mid:BANLkTikdxfLLjmzzLGo60i4FnFDWHK6MXw@mail.gmail.com"
type="cite"><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>
</blockquote>
<br>
Good point. There is an example for a doxygen config file in the
README.<br>
<br>
<blockquote
cite="mid:BANLkTikdxfLLjmzzLGo60i4FnFDWHK6MXw@mail.gmail.com"
type="cite"><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>
</blockquote>
<br>
The project contains a CMake function
(<a class="moz-txt-link-freetext" href="https://github.com/saschazelzer/CMakeDoxygenFilter/blob/master/FunctionCMakeDoxygenFilterCompile.cmake">https://github.com/saschazelzer/CMakeDoxygenFilter/blob/master/FunctionCMakeDoxygenFilterCompile.cmake</a>)
which is intended to be copied to the using project (CTK) and which
should download the source code (it is just one cpp file) and
compile it with TRY_COMPILE. This way, the documentation could be
generated without building CTK first. Due to missing SSL support in
CURL which ships with CMake (on Windows), downloading files from
github is not possible (same issue as with the CDash driver
script...). For MITK I copied the CMake function *and* the source
code to MITK (I don't expect the source code to change very often).<br>
<br>
After configuring CTK, the executable will have been built in the
binary tree and Doxyfile.txt.in config file will be configured to
contain a reference to the executable.<br>
<br>
I don't know if we should invest the extra effort of creating
another external project dependency to avoid the copying of the
source file...<br>
<br>
Thanks,<br>
Sascha<br>
<br>
<blockquote
cite="mid:BANLkTikdxfLLjmzzLGo60i4FnFDWHK6MXw@mail.gmail.com"
type="cite">
<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 moz-do-not-send="true"
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 moz-do-not-send="true"
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 moz-do-not-send="true"
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 moz-do-not-send="true"
href="mailto:Ctk-developers@commontk.org" target="_blank">Ctk-developers@commontk.org</a><br>
<a moz-do-not-send="true"
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>
</blockquote>
<br>
</body>
</html>