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. Scythe Mugen MAX
  2. Intel Core i7 5960X Haswell-E On Linux
  3. Intel 80GB 530 Series M.2 SSD On Linux
  4. With A New Motherboard, The Core i7 5960X Haswell-E Lights Up
Latest Linux Articles
  1. RadeonSI Gallium3D vs. Catalyst At 4K UHD On Linux
  2. MSAA RadeonSI Gallium3D Performance Preview
  3. Intel Core i7 5960X CPU Core Scaling Under Linux
  4. AMD RadeonSI Gallium3D Performance For 4K Linux Gaming
Latest Linux News
  1. Valve Begins Publicly Tracking AMD Catalyst Linux Issues
  2. Digia Qt Spinoff Is Called "The Qt Company"
  3. GNOME 3.14 Makes More Progress In Running Natively On Wayland
  4. Minix 3.3 Released With Cortex-A8 ARM Support, NetBSD Userland Compatibility
  5. More Intel DRM Changes Queued For Linux 3.18, Including Old i830M Fixes
  6. New Code Starts Lining Up For X.Org Server 1.17
  7. Rust Developers Planning For The Rust 1.0 Language
  8. RPM 4.12 Brings New Switches, New Rpm2Archive Utility
  9. Nouveau For Linux 3.18 Gains DP Audio, More Re-Clocking
  10. SUSE Gets Bought Out Again
Latest Forum Discussions
  1. New Group Calls For Boycotting Systemd
  2. support for first generation UVD blocks (RV6xx, RS780, RS880 and RV790)
  3. Nvidia joins the ranks of Apple and Microsoft
  4. Updated and Optimized Ubuntu Free Graphics Drivers
  5. Hd 6850
  6. nv and xorg.conf under Debian PPC
  7. X.Org Is Looking For Some Female Help
  8. FSF Issues Their Rebuttal To Apple's New iPhone, Watch & Apple Pay