 |
|
|
|
|
|
|
|
|
|
|
|
|
 SVUG Community Forum
|
|
| Author |
Messages |
|
JIM
Posts:2
 |
| 10/24/2007 6:18 PM |
|
I'd like to generate/extract documentation from my SV classes, packages, and programs using Doxygen or something like it. Simply feeding SV files to doxygen *almost* works, but generates lots of trash too. Does anyone have a pre-Doxygen filter or a suggestion on another tool to use to accomplish the task?
jt
|
|
|
|
|
TOM
Posts:1
|
| 11/06/2007 9:03 AM |
|
You might try NaturalDocs. You can find them here:
http://www.naturaldocs.org/
Not quite as powerful as Doxygen, but extremely easy to setup and use, and it produces nice, clean docs.
One key drawback is that it doesn't understand the language, so it can't chase base classes and such. But you can easily setup links between docs to minimize this problem.
It does know enough to parse function prototypes, and you identify key structures yourself. It is so easy to use that the limitations are acceptable.
Tom |
|
|
|
|
SEAN
Posts:3
|
| 12/06/2007 2:21 PM |
|
Hi Jim,
You probably already know this, but, Doxygen allows the use of filters written in pretty much any language (python, perl, compiled binary):
http://www.stack.nl/~dimitri/doxygen/config.html#cfg_input_filter
So assuming you knew that - then you're asking if anyone has a filter to share...
My previous company hired a very talented contractor that wrote a systemverilog filter for us in perl. It was about 150 lines...
Unfortunately - I don't have access to it... and even if I did; I don't own it.
Another idea:
I know that synopsys provides documentation of their VIP in doxygen. If you are a synopsys customer you may be able to convince them to share.
AND:
I highly encourage you to use the graphvis DOT application once you get doxygen up and running. It creates beautiful UML and usage diagrams.
-Sean
|
|
|
|
|
SASHI
Posts:1
|
| 01/14/2008 3:18 PM |
|
Check out our website, www.veriez.com.
Our EZReport knowledge extraction tool includes support for Doxygen. However, it is not free  , but very affordable.
Sashi Obilisetty
sashi@veriez.com
VeriEZ Solutions, Inc.
|
|
|
|
|
SEAN
Posts:1
|
| 09/23/2008 1:23 AM |
|
Here's a *free* doxygen filter:
Doxygen Filter for SystemVerilog
It's not perfect - but it works. (It was developed heuristically rather than using a grammar.)
The post explains how to use it and shows some example output.
Sean
|
|
|
|
|
VERIFCONSULT
Posts:8
|
| 10/20/2008 8:45 AM |
|
| Robodoc http://www.xs4all.nl/~rfsber/Robo/robodoc.html is a useful tool for documentation of Vera and SystemVerilog, since its language independent. |
|
|
|
|
|
| You are not authorized to post a reply. |
|
|
|
ActiveForums 3.7
|
|
|
|
|
|
|
|
|
|
|
|
|
 |
|