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.org

Clang Can Analyze Code Comments, Generate Docs

Compiler

Published on 18 November 2012 01:49 AM EST
Written by Michael Larabel in Compiler
5 Comments

Aside from why LLVM/Clang was ported to one of the fastest super computer's in the world and using Clang to implement Microsoft's C++ AMP, another interesting session at this month's LLVM Developers' Conference in San Jose was about using Clang to analyze code comments.

By having Clang parse documentation comments, Clang could be enhanced to do additional semantic checking, ensure the code comments remain relevant to the actual code, and code completion APIs could take advantage of the documentation within the code. Ultimately, a Doxygen-like tool could be created based upon Clang for generating proper documentation out of the code itself and the associated comments. Further out, automatic comment re-factoring could be done to update names referenced within the inline code comments so that the resulting documentation is always up-to-date.

Lots of this has already been implemented within Clang and the libclang library. Dmitri Gribenko of the HPC Center at the National Technical University of Ukraine in Kyiv presented on this work. There are PDF slides available for those interested in parsing documentation comments in Clang.

What's implemented up to this point is that Clang can parse documentation comments, find semantic errors in comments, and export comments as XML. Dmitri says, "This work enables more awesome features in future!"

Parsing of documentation comments isn't done by default since some programmers don't want it plus it would slow down the build process. This process is only done if -Wdocumentation is passed to the compiler front-end.

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. AMD FX-8320E Performance On Linux
  2. Linux Compiler Benchmarks Of LLVM Clang 3.5 vs. LLVM Clang 3.6-rc1
  3. Intel Broadwell HD Graphics 5500: Windows 8.1 vs. Linux
  4. Linux Benchmarks Of NVIDIA's Early 2015 GeForce Line-Up
  5. NVIDIA GeForce GTX 960: A Great $200 GPU For Linux Gamers
  6. Disk Encryption Tests On Fedora 21
Latest Linux News
  1. Compare Your Linux System To The i7-5600U Broadwell X1 Carbon ThinkPad
  2. Debian 8.0 "Jessie" Installer RC1 Released
  3. Chromebook "Rush" With 64-bit Tegra SoC Support Lands In Coreboot
  4. 2015 X.Org Elections Get Underway For Board Members, SPI Merger
  5. Linux 3.19-rc6 Kernel Released: LInux 3.19 Final In Two Weeks
  6. Ubuntu's Mir Gains Server-Side Platform Probing
  7. Broadwell Linux Ultrabook Running MUCH Cooler Than Haswell
  8. LZHAM 1.0 Lossless Data Compression Codec Released
  9. LibreOffice 4.4 Is Coming Soon With New Features
  10. Linux Users Upset By Chromium's Busted HiDPI Support
Most Viewed News This Week
  1. Windows 10 To Be A Free Upgrade: What Linux Users Need To Know
  2. Google Admin Encourages Trying Btrfs, Not ZFS On Linux
  3. TraceFS: The Newest Linux File-System
  4. My Initial Intel Broadwell Linux Experience With The ThinkPad X1 Carbon
  5. Mozilla's Servo Still On Track For 2015 Alpha Release
  6. Fedora 23 Likely To Pursue Wayland By Default
  7. Keith Packard Leaves Intel's Linux Graphics Work
  8. Interstellar Marines On Linux With Catalyst: Bull S*#@