CMinx: A CMake Documentation Generator
- Ames Laboratory, and Iowa State University, Ames, IA (United States)
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, 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, 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 or easily converted to another format via Pandoc.
- Research Organization:
- Ames Laboratory (AMES), Ames, IA (United States)
- Sponsoring Organization:
- USDOE Office of Science (SC); USDOE National Nuclear Security Administration (NNSA)
- Grant/Contract Number:
- AC02-07CH11358
- OSTI ID:
- 1890187
- Report Number(s):
- IS-J-10,902
- Journal Information:
- Journal of Open Source Software, Journal Name: Journal of Open Source Software Journal Issue: 77 Vol. 7; ISSN 2475-9066
- Publisher:
- Open Source Initiative - NumFOCUSCopyright Statement
- Country of Publication:
- United States
- Language:
- English
Addressing failures in exascale computing
|
journal | March 2014 |
| xSDK Foundations: Toward an Extreme-scale Scientific Software Development Kit | preprint | January 2017 |
Similar Records
Best practices for documenting a scientific Python project
Users manual for doctext: Producing documentation from C source code