1. Computers
  2. Display Drivers
  3. Graphics Cards
  4. Memory
  5. Motherboards
  6. Processors
  7. Software
  8. Storage
  9. Operating Systems


Facebook RSS Twitter Twitter Google Plus


Phoronix Test Suite

OpenBenchmarking Benchmarking Platform
Phoromatic Test Orchestration

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

Compiler

Published on 12 February 2013 12:35 PM EST
Written by Michael Larabel in Compiler
11 Comments

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.

About The Author
Michael Larabel is the principal author of Phoronix.com and founded the web-site in 2004 with a focus on enriching the Linux hardware experience and being the largest web-site devoted to Linux hardware reviews, particularly for products relevant to Linux gamers and enthusiasts but also commonly reviewing servers/workstations and embedded Linux devices. Michael has written more than 10,000 articles covering the state of Linux hardware support, Linux performance, graphics hardware drivers, and other topics. Michael is also the lead developer of the Phoronix Test Suite, Phoromatic, and OpenBenchmarking.org automated testing software. He can be followed via and or contacted via .
Latest Linux News
  1. Yet Another OpenGL 4.5 Extension Is Nearing Completion In Mesa
  2. Xfce's Power Manager Is Finally Ported To GTK3
  3. The CompuLab Fitlet Is A Neat Little Linux PC With AMD SoC
  4. AMD & Others Are Working On The LLVM SPIR-V Converter
  5. Linux 4.1-rc5 Kernel Released
  6. Mesa 10.5.6 Brings Fixes All Over The Place
  7. NVIDIA's Proprietary Driver Is Moving Closer With Kernel Mode-Setting
  8. The Latest Linux Kernel Git Code Fixes The EXT4 RAID0 Corruption Problem
  9. Features Added To Mesa 10.6 For Open-Source GPU Drivers
  10. Ubuntu's LXD vs. KVM For The Linux Cloud
Latest Articles & Reviews
  1. Opening The Gates To Our Daily Open-Source Linux Benchmark Results
  2. The Latest Features For Linux Performance Management + Benchmark Monitoring
  3. Noctua NH-U12DX i4 + NF-F12
  4. Btrfs RAID 0/1 Benchmarks On The Linux 4.1 Kernel
Most Viewed News This Week
  1. The Linux 4.0 Kernel Currently Has An EXT4 Corruption Issue
  2. The Linux 4.0 EXT4 RAID Corruption Bug Has Been Uncovered
  3. Microsoft Open-Sources The Windows Communication Foundation
  4. NVIDIA's Proprietary Driver Is Moving Closer With Kernel Mode-Setting
  5. Systemd 220 Has Finally Been Released
  6. Another HTTPS Vulnerability Rattles The Internet
  7. LibreOffice 5.0 Open-Source Office Suite Has Been Branched
  8. LibreOffice 5.0 Beta 1 Released