Quickstart

CMinx assumes you’ve commented your custom CMake functions and macros like:

#[[[
# A brief description.
#
# A more detailed description, must be separated from the brief by at least
# one blank line.
#
# :param param0: The 0-th parameter passed to the function
#]]
function(quickstart param0)
    message("This function says: ${param0}")
endfunction()

Assuming that this function is defined in the file quickstart.cmake, located in your current working directory, reST documentation for this CMake module is generated by running:

foo@bar:~$ cminx -o output_dir/ quickstart.cmake

The result will be in a file output_dir/quickstart.rst.