![[logo]](/img/veripool_small.png)
Patch #482
Enable doxygen analysis of Verilator source
| Status: | Closed | Start date: | 04/15/2012 | |
|---|---|---|---|---|
| Priority: | Normal | Due date: | ||
| Assignee: | Jeremy Bennett | % Done: | 0% |
|
| Category: | Documentation | |||
| Target version: | - |
Description
The attached patch provides "make doxygen" to generate a doxygen analysis of the Verilator C++ source.
Doxygen is an automated documentation system for numerous languages, including C++ (similar to JavaDoc). It can generate an on-line documentation browser (in HTML) and/or an off-line reference manual (in $\mbox{\LaTeX}$) from the source code, extracting the code structure from the source files.
For developers new to Verilator it provides a very helpful way for understanding the class hierarchy, and finding the details of individual functions.
History
Updated by Wilson Snyder about 1 year ago
I've used doxygen, it's good. There's a small set of doxygen comments in some of the include files, from stuff inherited from some of my other packages.
Which logo did you pick, it wasn't in the patch as it's binary.
Updated by Wilson Snyder about 1 year ago
- Status changed from New to Closed
- Assignee set to Jeremy Bennett
Pushed to git. I disabled HAS_DOT, as after an hour it was only maybe 20% done.
Updated by Jeremy Bennett about 1 year ago
- File veripool-logo.png added
Thanks for this.
The HAS_DOT time is strange. The whole thing goes through on my workstation in a few minutes (3 year old quad-core Intel running Fedora-16).
I grabbed the image from the website and shrank it to the size required by Doxygen (max 55 pixels high). I've attached it.
Also available in: Atom