CLDOC: A Clang-Based C/C++ Document Generator
CLDOC is a document generator for C and C++ projects to create documentation automatically out of comments as well as creating XML-based descriptions of the API. CLDOC is a new project but already sounds promising and is being powered by LLVM's Clang C/C++ front-end for its parser.
Jesse van den Kieboom, a GNOME developer, is the one responsible for starting CLDOC. CLDOC is a Clang-based document generator for C and C++ code-bases that doesn't require any configuration or special integration routines to utilize. The output is nice and modern with its use of XML, JavaScript, and other modern web functionality.
Current features of CLDCO is robust parsing via Clang without requiring added effort by the user, zero configurations needed, uses markdown for documentation formatting, can generate an XML API description, simple format for code documentation, supports document cross-referencing, generates a single file that then works with its JavaScript-based web application, easily can be integrated into web-sites, and supports client-side searching.
More details on CLDOC for Clang-based document generation can be found in this blog post by Jesse van den Kieboom. The code to CLDOC is hosted on GitHub.
Jesse van den Kieboom, a GNOME developer, is the one responsible for starting CLDOC. CLDOC is a Clang-based document generator for C and C++ code-bases that doesn't require any configuration or special integration routines to utilize. The output is nice and modern with its use of XML, JavaScript, and other modern web functionality.
Current features of CLDCO is robust parsing via Clang without requiring added effort by the user, zero configurations needed, uses markdown for documentation formatting, can generate an XML API description, simple format for code documentation, supports document cross-referencing, generates a single file that then works with its JavaScript-based web application, easily can be integrated into web-sites, and supports client-side searching.
More details on CLDOC for Clang-based document generation can be found in this blog post by Jesse van den Kieboom. The code to CLDOC is hosted on GitHub.
11 Comments