CLDOC: A Clang-Based C/C++ Document Generator

Posted by Michael Larabel on February 12, 2013

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.

Discuss this article in our forums, IRC channel, or email the author. You can also follow our content via RSS and on social networks like Facebook, Identi.ca, and Twitter (@Phoronix and @MichaelLarabel). Subscribe to Phoronix Premium to view our content without advertisements, view entire articles on a single page, and experience other benefits.
Latest Hardware Reviews
  1. Intel Haswell HD Graphics 4600 vs. AMD Radeon Graphics On Linux
  2. Intel Haswell HD Graphics 4600 Performance On Ubuntu Linux
  3. Intel Core i7 4770K "Haswell" Benchmarks On Ubuntu Linux
  4. The First Experience Of Intel Haswell On Linux
Latest Software Articles
  1. Optimized Binaries Provide Great Benefits For Intel Haswell
  2. 11-Way Linux, BSD Platform Comparison
  3. SNA Acceleration Works Great For Intel Core i7 Haswell
  4. The Linux Evolution For Intel Haswell's Performance
Latest Linux News
  1. Mir's GPLv3 License Is Now Raising Concerns
  2. NVIDIA Driver Soon Likely To Support EGL, Mir
  3. OpenMandriva Goes Into Alpha Form, Russian-Based
  4. NVIDIA Brings Their Linux Driver To ARM
  5. D Language Still Showing Promise, Advancements
  6. Planetary Annihilation Released For Linux Gamers
  7. Gentoo Starts Work On KDE-Wayland Support
  8. NVIDIA To License Its Kepler GPU Technology
  9. KDE's KWin Made Lots Of Progress In 4.11
  10. Ubuntu Announces Carrier Advisory Group
  11. Qt 5.1 Release Candidate 1 Has Arrived
Latest Forum Talk
  1. VP9 Codec Now Enabled By Default In Chrome
  2. Mir's GPLv3 License Is Now Raising Concerns
  3. In-Fighting Continues Over Mir On Non-Unity Ubuntu
  4. D Language Still Showing Promise, Advancements
  5. Gentoo Starts Work On KDE-Wayland Support
  6. Benchmarking The Intel P-State, CPUfreq Changes
  1. Computers
  2. Display Drivers
  3. Graphics Cards
  4. Motherboards
  5. Peripherals
  6. Processors
  7. Software
  8. Operating Systems
  9. All Articles
  1. Linux Benchmarking
  2. OpenBenchmarking.org
  3. Phoronix Test Suite