Now that CMake is using RST for documentations, is there a good guide for how to document modules that mainly provide new functions?

In particular, I am wondering if it is possible, and if so, what recommendations there are if any, to document functions 'doxygen style', i.e. the documentation immediately preceding the function definitions, rather than all at the top.

And/or, what parts of a CMake module are extracted for documentation and is there a way to say 'ignore comments after this point'?

Any pointers are appreciated. Thanks,

--
Matthew

--

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://public.kitware.com/cgi-bin/mailman/listinfo/cmake-developers

Reply via email to