For example, the module instantiations are not currently recognized as function calls, so doxygen does not generate a call graph representing the hierarchy of instantiations. This is a great start, but there's room for improvement.
Doxygen verilog code#
When the code is then run through doxygen via this filter, the result is that each module and interface is documented as a function with the description, the definitions for the ports (parameters) and descriptions of the redefinable parameters (template parameters). The structs are handled just like they are in C\C++ and the modules and interfaces are both handled by translating these into functions, where the ports are documented as entries and the redefinable parameters are documented as entries. For example, my project primarily documents modules, interfaces and structures. The script works by attempting to translate the HDL into something that can be parsed as if it were C++. To better understand the potential - I am currently using this (with a few minor custom hacks) to document an FPGA project written in SystemVerilog. It is not limited to classes - I found it to be a viable option in its current state and think it also has a lot of potential. If you have Dot installed, you will get about 38Mbytes of html data to browse at your leisure.For anybody looking to generate documentation for Verilog or SystemVerilog, I would recommend taking a look at the IDV doxygen filter noted in the original question. When you've edited the configuration file to match your situation (remember you may have to tell it that you don't have Dot if you don't have Dot, by setting HAVE_DOT = NO), then just run doxygen as follows doxygen systemc201cfg The configref file is here, the SystemC 2.0.1 file we used is here, and the differences file is here. (Note: you may have to right click on the following links and click "save as", otherwise the files will just open in your browser). This file of differences shows you what we had to edit to get doxygen working. You can also download a file of differences between our configuration file and the default. To save you a bit of trouble, you can download our configuration file here. You need to specify directories to search, whether you have Dot or not, which file extensions to search for, and so on. You can create a reference configuration file by running doxygen -g configrefĪnd then edit the default file. Configuring Doxygenĭoxygen can be configured using a text configuration file directly, or using a front-end GUI configuration editor "doxywizard".
Doxygen verilog install#
Note that if you want Graphviz/Dot, you should install Graphviz before you install Doxygen.
On Linux RedHat 7.3, we downloaded an rpm of Graphviz, and then installed Doxygen from source using gcc 2.95.3. Graphviz is available here.īoth tools can be downloaded and installed straighforwardly from source on Unix platforms. What this means is that you get prettier pictures if you have Graphviz. For the best results, Doxygen can make use of a tool called Dot, which is supplied as part of the graphics visualization library Graphviz. Fortunately for SystemC (which doesn't have such meta-comments!) it can also be made to extract absolutely everything.
It was written to scan through programs and automatically generate documentation based on meta-comments added to the program.
Doxygen verilog license#
Legal issues, Trademarks and Acknowledgementsĭoxygen is a documentation generation tool, licensed under the Gnu Public License (GPL).When to use Helper Code to Accelerate Formal.
Doxygen verilog drivers#
Managing Devices with Linux Device Drivers.C/C++ Memory Management: Design & Debugging.Rapid Creation of Edge AI solutions on an FPGA.Deep Learning - in the Cloud and at the Edge.
0 kommentar(er)
