Note: I have additionally posted this question to stack overflow so if you would like to answer there rather than email it may help a larger audience: https://stackoverflow.com/questions/54660549/what-is-the-proper-way-to-document-a-cmake-module
On Tue, Feb 12, 2019 at 6:37 PM Timothy Wrona <tjwrona1...@gmail.com> wrote: > 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 >
-- Powered by www.kitware.com Please keep messages on-topic and check the CMake FAQ at: http://www.cmake.org/Wiki/CMake_FAQ Kitware offers various services to support the CMake community. For more information on each offering, please visit: CMake Support: http://cmake.org/cmake/help/support.html CMake Consulting: http://cmake.org/cmake/help/consulting.html CMake Training Courses: http://cmake.org/cmake/help/training.html Visit other Kitware open-source projects at http://www.kitware.com/opensource/opensource.html Follow this link to subscribe/unsubscribe: https://cmake.org/mailman/listinfo/cmake-developers
