Hi there!
I would like to know if there are any automatic documentation
generators
similar to Doxygen for vhdl.
I'm using Naturaldocs - it doesn't understand VHDL directly, although
one day I might get around to writing an extension for it. However, it
does allow you to use very natural comments in your code (I even put
ascii art timing diagrams in
and produce nice HTML out the back
end with an index and even a search engine! Most of the other doc
generators I looked at were either full of weird symbols to make it
work, which makes the code look bizarre to outsiders who pick it up,
or worked very badly on Windows, which is a bad thing where I work...
With ND, I have an emacs macro which takes my entity defintion (with
comments on the end of each port/generic item) and creates a
Naturaldocs comment automatically like this:
-- Entity: adder
-- Port:
-- clk - clock signal
-- A - input A
-- B - input B
-- Y - the result of adding A+B
-- then I can write more documentation here...
and ND creates me a nicely formatted set of HTML files. So the
incremental effort of using ND is very small, given you've already
written some decent comments in your code (we all do that don't we
Cheers,
Martin
