CMakePP / CMinx

Generates API documentation for CMake functions and macros
https://cmakepp.github.io/CMinx/
Apache License 2.0
14 stars 5 forks source link

Generic command documentation #54

Closed AutonomicPerfectionist closed 2 years ago

AutonomicPerfectionist commented 2 years ago

This PR adds functionality to document any CMake command, whether or not they are a known definition command. For example, if the following is in a file called example.cmake:

#[[[
# This is a documented message command
#]]
message("This is a message")

Running this through CMinx will generate the following RST:

#############
example.cmake
#############

.. module:: example.cmake

.. function:: message("This is a message")

   .. warning:: This is a generic command invocation. It is not a function or macro definition.

   This is a documented message command

This fixes #51

AutonomicPerfectionist commented 2 years ago

@ryanmrichard does this look like what you were thinking or should the admonition be adjusted a bit more?

dschiller commented 2 years ago

Amazing Branden and Ryan!!