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. NVIDIA's $1000+ GeForce GTX TITAN X Delivers Maximum Linux Performance
  2. OS X 10.10 vs. Ubuntu 15.04 vs. Fedora 21 Tests: Linux Sweeps The Board
  3. The New Place Where Linux Code Is Constantly Being Benchmarked
  4. 18-GPU NVIDIA/AMD Linux Comparison Of BioShock: Infinite
  5. Phoronix Test Suite 5.6 Adds New Phoromatic Enterprise Benchmarking Features
  6. OpenGL Threaded Optimizations Responsible For NVIDIA's Faster Performance?
Latest Linux News
  1. Shadow Warrior Is Being Released For Linux Next Week
  2. Intel Pushes A Bunch Of Broadwell Code Into Coreboot
  3. Open-Source Driver Fans Will Love NVIDIA's New OpenGL Demo
  4. GHC 7.10.1 Brings New Compiler Features
  5. Git 2.4.0-rc0 Does A Ton Of Polishing
  6. The Most Common, Annoying Issue When Benchmarking Ubuntu On Many Systems
  7. Mesa Is At Nearly 1,500 Commits This Year
  8. Gestures & Other GTK3 Features For LibreOffice
  9. It's Now Easier To Try PHP 7 On Fedora & RHEL
  10. BQ Is Cleaning Up Their Aquaris E4.5 Ubuntu Kernel
Most Viewed News This Week
  1. Introducing The Library Operating System For Linux
  2. AMD Is Hiring Two More Open-Source Linux GPU Driver Developers
  3. New SecureBoot Concerns Arise With Windows 10
  4. GNOME Shell & Mutter 3.16.0 Released
  5. GNU Nano 2.4.0 Brings Complete Undo System, Linter Support & More
  6. Systemd Change Allows For Stateless Systems With Tmpfs
  7. Red Hat Is Rolling Out A VirtIO DRM/KMS GPU Driver
  8. GCC 5 Compiler Is Getting Close To Being Released