Documenting a CMakeTest Test

CMinx can be used to document CMakeTest tests and test sections. Again, this is done analogous to other documentation use cases, i.e., by proceeding the ct_add_test or ct_add_section command with a documentation comment. For example,

#[[[
# This is how you document a CMakeTest test.
#]]
ct_add_test(NAME test1 EXPECTFAIL)
function(${test1})

    #[[[
    # And this is how you document a CMakeTest section.
    #]]
    ct_add_section(NAME section1 EXPECTFAIL)
    function(${section1})
    endfunction()

endfunction()

which generates:

####################
test_samples.ct_test
####################

.. module:: test_samples.ct_test


.. function:: test1(EXPECTFAIL)


   .. warning:: This is a CMakeTest test definition, do not call this manually.

   This is how you document a CMakeTest test.
   


.. function:: section1(EXPECTFAIL)


   .. warning:: This is a CMakeTest section definition, do not call this manually.

   And this is how you document a CMakeTest section.