cid 83157d18122b01e8f6eac6c9a63fce61a595496a3f8c144e79fe4769e8d12416 · original · open access · via openalex
Title: CMinx: A CMake Documentation Generator Authors: Branden Butler; Ryan M. Richard Venue: The Journal of Open Source Software Year: 2022 Canonical: doi:10.21105/joss.04680 URL: https://doi.org/10.21105/joss.04680 Collector: openalex OA: true ABSTRACT This manuscript introduces CMinx, a program for generating application programming interface (API) documentation written in the CMake language, and CMake modules in particular.Since most of CMinx's intended audience is comprised of C/C++ developers, CMinx is designed to operate similar to Doxygen (Heesch, 2022), the de facto C/C++ API documentation tool.Specifically, developers annotate their CMake source with "documentation" comments, which are traditional CMake block comments starting with an extra "[" character.The documentation comments, written in reST (reStructuredText, 2022), describe to the reader how the functions, parameters, and variables should be used.Running CMinx on the annotated source code generates reST files containing the API documentation.The reST files can then be converted into static websites with tools such as Sphinx (Sphinx, 2022) or easily converted to another format via Pandoc (Pandoc, 2022).