[CMake] Suggestions on documenting my CMake modules

Jean-Christophe Fillion-Robin jchris.fillionr at kitware.com
Sat Oct 29 16:45:47 EDT 2011


Hi Robert,

Within CTK <http://commontk.org>, Sasha implemented a Doxygen filter for
CMake. You could refer to the following:
  https://github.com/saschazelzer/CMakeDoxygenFilter/blob/master/README

https://github.com/commontk/CTK/blob/master/CMake/ctkFunctionCMakeDoxygenFilterCompile.cmake

Hth
Jc


On Sat, Oct 29, 2011 at 3:46 PM, Robert Dailey <rcdailey at gmail.com> wrote:

> I have several complex functions which require a ton of documentation. I
> wanted to type this documentation directly in the cmake file right above
> the function() itself, but it is turning out to be a formatting nightmare.
>
> What would you guys recommend as far as this kind of documentation goes?
> It would be great if doxygen could scan CMake scripts and generate HTML
> documentation out of them, but I don't know if this is possible. Also,
> typing up the documentation in a wiki externally would ease the formatting
> but would require people to go to an external source for documentation that
> would otherwise be immediately available in the code itself.
>
> Ideas?
>
> ---------
> Robert Dailey
>
> --
>
> Powered by www.kitware.com
>
> Visit other Kitware open-source projects at
> http://www.kitware.com/opensource/opensource.html
>
> Please keep messages on-topic and check the CMake FAQ at:
> http://www.cmake.org/Wiki/CMake_FAQ
>
> Follow this link to subscribe/unsubscribe:
> http://www.cmake.org/mailman/listinfo/cmake
>



-- 
+1 919 869 8849
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://www.cmake.org/pipermail/cmake/attachments/20111029/1008a3ff/attachment.htm>


More information about the CMake mailing list