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 Linux Hardware Reviews
  1. 13-Way Low-End GPU Comparison With AMD's AM1 Athlon
  2. ASUS AM1I-A: A Mini-ITX Board For Socketed Kabini APUs
  3. Mini-Box M350: A Simple, Affordable Mini-ITX Case
  4. Overclocking The AMD AM1 Athlon & Sempron APUs
Latest Linux Articles
  1. How Much Video RAM Is Needed For Catalyst R3 Graphics?
  2. Ubuntu 12.04 LTS vs. 14.04 LTS Cloud Benchmarks
  3. Ubuntu 12.04.4 vs. 13.10 vs. 14.04 LTS Desktop Benchmarks
  4. AMD OpenCL Performance With AM1 Kabini APUs
Latest Linux News
  1. OpenELEC 4.0 Beta 6 Works On 4K Graphics, RPi ALSA
  2. Linux 3.15 Lands Some DRM Graphics Driver Fixes
  3. AMD Is Disabling DPM Support For RV770 GPUs
  4. ReactOS Working On A Community Windows OS
  5. Borderlands Is Being Considered For Linux
  6. Mesa 10.0 & 10.1 Stable Get Updated
  7. Getting Hit By The Variable Performance Of The Public Cloud
  8. Git 2.0 Test Releases Begin With Many Changes
  9. Wine 1.7.17 Works On Its Task Scheduler, C Run-Time
  10. The Improv ARM Board Still Isn't Shipping; Riding A Dead Horse?
  11. Debian To Maintain 6.0 Squeeze As An LTS Release
  12. Wasteland 2 Is Finally Released For Linux Gamers
Latest Forum Discussions
  1. The GNOME Foundation Is Running Short On Money
  2. Updated and Optimized Ubuntu Free Graphics Drivers
  3. Catalyst 14.3 Beta
  4. Suggestions about how to make a Radeon HD 7790 work decently?
  5. Radeon 8000M problematic on Linux?
  6. Linux Kernel Developers Fed Up With Ridiculous Bugs In Systemd
  7. After Jack Keane, RuseSoft will briing Ankh 3 to Linux through Desura
  8. Suspected PHP Proxy Issue