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. Btrfs In Linux 4.2 Brings Quota Updates, Many Fixes
  2. Latest Rumor Pegs Microsoft Wanting To Buy AMD
  3. The Next-Gen Phoronix Site Experience Is Almost Ready
  4. Exciting Features Merged So Far For The Linux 4.2 Kernel
  5. Mesa 10.6.1 Brings A Bug-Fix For Dota 2 Reborn
  6. DragonFlyBSD 4.2 Released: Brings Improved Graphics & New Compiler
  7. Wine-Staging 1.7.46 Improves The OS X Experience
  8. The State & Complications Of Porting The Unity Editor To Linux
  9. Libreboot Now Supports An AMD/ASUS Motherboard
  10. SafeStack Merged Into LLVM To Protect Against Stack Buffer Overflow Attacks
Latest Articles & Reviews
  1. How KDE VDG Is Trying To Make Open-Source Software Beautiful
  2. Attempting To Try Out BCache On The Linux 4.1 Kernel
  3. CompuLab's Fitlet Is A Very Tiny, Fanless, Linux PC With AMD A10 Micro
  4. AMD A10-7870K Godavari: RadeonSI Gallium3D vs. Catalyst Linux Drivers
Most Viewed News This Week
  1. Kubuntu 15.10 Could Be The End Of The Road
  2. Linus Is Looking Forward To Merging KDBUS, But Not Convinced By Performance
  3. NVIDIA Starts Supplying Open-Source Hardware Reference Headers
  4. KDBUS Won't Be Pushed Until The Linux 4.3 Kernel
  5. Linux 4.2 Kernel Gets Port To New Processor Architecture
  6. The Staging Pull For Linux 4.2: "Big, Really Big"
  7. EXT4 Has Many Cleanups & Fixes For Linux 4.2
  8. SteamOS "Brewmaster" Is Valve's New Debian 8.1 Based Version