[cmake-developers] Properly Documenting a CMake Module

[Timothy Wrona]

A quick Google search (...actually many rather extensive Google searches)
have not been able to explain how to properly document a CMake module.

What I'm looking for is a way to document custom CMake modules so that they
work with the "cmake --help-module <module_name>" command. Is there any
standard way of doing this? Can anyone point me to some good examples? The
documentation process seems oddly.... not well documented. Haha.

How are modules that work with "cmake --help-module" documented?

Any help is appreciated.

Thanks,
Tim
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://cmake.org/pipermail/cmake-developers/attachments/20190212/b26e8b38/attachment.html>