VHDLDOC

HTML documentation facility for VHDL code, developed at CERN

The development started from the kdoc package by Sirtaj Singh Kang (under GNU license) and therefore is under GNU license. The package was developed in order to document the VHDL source of the MIROD module for the ATLAS experiment.

VHDLDOC is a tool to generate automatically hyperlinked html-documentation of vhdl-code. The markup-language is like the one of JAVADOC. As an example you can look at the documentation of the Lvl2Processor (an ALTERA FPGA developed for the MUCTPI).

You can download the package.

Edward Schram made vhdldoc-rel-2-5 running on Windows with ActivePerl. He was so kind to send me his modifications. I have not tested it. You can download the version vhdldoc_rel-2-5-win.zip here.

The online manual gives you information on how to use/install the package.

If you are interested in some emacs-lisp code which generates headers for your vhdl documentation automatically you can contact me (Christoph.Schwick@cern.ch).


last change : $Date: 2000/09/08 05:36:19 $