Doxygen Filter for System Verilog 2.2.0 Released

A new filter release – and this one has a significant new feature.  The filter now recognizes and groups interface, program, and module blocks.

An example of what this looks like is in the VMM documentation over here:

http://intelligentdv.com/documents/index.html#vmmdox

This release includes:

  • bugfix: No support for parameterized interfaces (#29)
  • feature: Added support for inline block comment
  • feature: Changed macro parsing to convert the macro to doxygen-able code – this means that macros will display as valid C++ code (rather than the more familiar SV code); but also means that macro generated code is properly shown in the doxygen documentation (like the macro generated AVM classes in the OVM library)
  • feature: Improved covergroup and constraint processing: now make them look like methods that return type covergroup (or constraint)
  • bugfix: Fixed class extends template class
  • bugfix: Fixed template angle bracket replacement algorithm (still not perfect, but better)
  • bugfix: LRM apparently allows a space between the # and ( in a parameter port – fixed this
  • feature: Added improved doxygen output for interfaces, modules, and programs (doxygen modules)
  • feature: Added support for parameterized modules and interfaces – document as templatized methods
  • cleanup: Combined module and interface parsing
  • feature: Added layout xml file to change modules tab name (a doxygen 1.5.8+ feature)

You can pick up the release from the downloads page here:

http://intelligentdv.com/downloads/index.html#doxygentools

Or – you can grab it directly from the subversion repository with your svn client (or using the WebSVN site here).

TIP! These blog announcements often lag the actual release by several weeks…  so I recommend subscribing to the RSS feed for the Doxygen tags on the WebSVN site to keep up-to-date.

A Reminder: the doxygen filter is not a grammar — it, like the doxygen tool, is a lexical parser. So – you will find bugs.  And when you do – please file them to the bug tracker here:

http://intelligentdv.com/bugs/

-Better (not always the enemy of good)

Leave a Reply