VHDL documentation tool
jo...@doe.com
I'm looking for a tool to automatically build a documentation parsing VHDL
files.
I'm currently using Doxygen, but the VHDL support is rather poor, and it
doesn't build a gerarchy diagram.
Any suggestion?
rix
Jonathan Bromley
Have you tried www.sigasi.com ?
Not quite what you're looking for, but it may have some
interesting and useful features that are relevant.
--
Jonathan Bromley, Consultant
DOULOS - Developing Design Know-how
VHDL * Verilog * SystemC * e * Perl * Tcl/Tk * Project Services
Doulos Ltd., 22 Market Place, Ringwood, BH24 1AW, UK
jonathan...@MYCOMPANY.com
http://www.MYCOMPANY.com
The contents of this message may contain personal views which
are not the views of Doulos Ltd., unless specifically stated.
Paul Floyd
Paul Floyd
I've only used Doxygen with C++ and C, and found its various diagrams
quite impressive. You need dot to get the most out of it.
What do you mean by gerarchy? Hierarchy?
A bientot
Paul
Martin Thompson
I've used Natural Docs with VHDL - with the following in Languages.txt:
Language: Vhdl
Extensions: vhd vho vhm
Line Comment: --
Block Comments:
Package Separator: .
Enum Values: Global
Function Prototype Enders: ; is
Variable Prototype Enders: ; :=
Language: UCF
Extension: ucf
Line Comment: #
Block Comments:
It doesn't do a bad job IMHO, although it's not perfect, as it is
"template matching" rather than truely understanding the VHDL. It
also doesn't generate a hierarchy diagram.
Cheers,
Martin
--
martin.j...@trw.com
TRW Conekt - Consultancy in Engineering, Knowledge and Technology
http://www.conekt.net/electronics.html
Benjamin Couillard
There's VHDLDOC lying around on the internet that generates some kind
of hierarchy diagram. However, there some bugs in it and you might
need to modify the perl script in order to make it work.
Benjamin Couillard
wrote:
> There's VHDLDOC lying around on the internet that generates some kind
> of hierarchy diagram. However, there some bugs in it and you might
> need to modify the perl script in order to make it work.
I also agree that Doxygen isn't really suited for VHDL. It seems like
someone patched doxygen for VHDL.
Paul Floyd
And what would you you say is lacking?
Benjamin Couillard
A hierarchy diagram mostly, because the inheritance diagram in the
exmple below is somehow meaningless.
For "regular" programming language like C, I think that doxygen is
greatto document self-contained modules (like a driver for example),
but less so to document a whole project.