使用Doxygen为VHDL工程生成文档模板

在开发一个项目的时候，也会同时写说明文档的，这时候大家会自然而然想到用word来写，但是word写出来的文档，不便于阅读，所以这里推荐一个文档生成工具：Doxygen。

目前的Doxygen还不支持verilog（Doxverilog同时支持VHDL和verilog，但需要使用VS编译源代码，有兴趣的朋友可以参考这里），所以这里，以VHDL的工程作为示例（其它语言也一样的，如：C/C++、JAVA等）。

一、下载Doxygen。

http://sourceforge.net/projects/doxygen/files/?source=navbar

二、打开doxywizard

在安装目录的\doxygen\bin下，打开doxywizard，并按照下面的步骤设置参数。

点Run doxygen之后，会生成一堆文件，接着，用下面的工具把这一堆文件编译成一个文件。

可以用Save as把刚才设置好的参数，保存为一个文件，这样以后就不用那么麻烦了。

三、下载并安装HTML Help Workshop。

http://www.greenxf.com/soft/31805.html

打开由Doxygen生成的index.hhp文件。

点下图红圈所示位置，即可生成.chm文件。

如果编译没错的话，会出现如下图所示。

好了，.chm文件已经生成了。

诚然，这个.chm文件只是个模板而已(这个模板已经帮我们减轻很多工作量了)，必要的文字说明，都可以修改那些.html或者.htm文件，此外，生成的.chm文件还有些乱码，需要手工修改的。