Using CMinx to Document Your Code

Note

This documentation assumes you are familiar with reStructuredText (reST) and CMake.

• Types of Comments
• Documenting a Module
• Documenting a Function
  • Basic Function Documentation
  • Documenting Keyword Arguments
  • Recommended reST Directives
• Documenting a Macro
• Documenting a Variable
• Documenting a CMakeTest Test