[cmake-developers] documenting a CMake 'use' file

Matthew Woehlke matthew.woehlke at kitware.com
Fri Nov 22 15:24:18 EST 2013


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




More information about the cmake-developers mailing list