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 Articles & Reviews
  1. Ubuntu 15.04 Offers Faster OpenGL For AMD Radeon GPUs On Open-Source
  2. Ubuntu 15.04 Brings Some Graphics Performance Improvements For Intel Haswell
  3. Sub-$20 802.11n USB WiFi Adapter That's Linux Friendly
  4. The Lenovo T450s Is Working Beautifully With Linux
  5. Linux 4.0 SSD EXT4 / Btrfs / XFS / F2FS Benchmarks
  6. Linux 4.0 Hard Drive Comparison With Six File-Systems
Latest Linux News
  1. GCC 5.2 Will Come In Two To Three Months
  2. AMD FP3 Motherboard Ported To Coreboot
  3. The Difference In Optimizations Between NIR & GLSL
  4. OpenMandriva Lx 3 Alpha: Adds UEFI Support, Defaults To LXQt
  5. Systemd Kills Off Shutdownd
  6. There's Now More Than 1,100 Games On Steam For Linux
  7. Btrfs In Linux 4.1 Has Fixes For File-Systems Of 20 Terabytes & Up
  8. Microsoft's CoreCLR Now Works On FreeBSD
  9. Unigine 2.0 Beta 2 Brings PBR, SSR, Kinect 2 Support
  10. KDBUS Still Hasn't Been Pulled, Might Not Land For Linux 4.1
Most Viewed News This Week
  1. AMD Releases New "AMDGPU" Linux Kernel Driver & Mesa Support
  2. Ubuntu's Desktop-Next Switching From .DEBs To Snappy
  3. My Favorite Computer Desk Of The Past Decade For Less Than $100
  4. EXT4 In Linux 4.1 Adds File-System Level Encryption
  5. AMD Open-Sources "Addrlib" From Catalyst
  6. Library Operating System (LibOS) For Linux Still Being Pursued
  7. Debian 8.0 Jessie Is Ready For Release This Weekend
  8. Linux-Powered Endless Computer Raises $100k+ In A Few Days