Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Enable doxygen analysis of Verilator source #482

Closed
veripoolbot opened this issue Apr 15, 2012 · 3 comments
Closed

Enable doxygen analysis of Verilator source #482

veripoolbot opened this issue Apr 15, 2012 · 3 comments
Labels
area: documentation Issue involves documentation resolution: fixed Closed; fixed

Comments

@veripoolbot
Copy link
Contributor

Author Name: Jeremy Bennett (@jeremybennett)
Original Redmine Issue: 482 from https://www.veripool.org
Original Date: 2012-04-15
Original Assignee: Jeremy Bennett (@jeremybennett)

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.
@veripoolbot
Copy link
Contributor Author

Original Redmine Comment
Author Name: Wilson Snyder (@wsnyder)
Original Date: 2012-04-15T18:36:45Z

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.

@veripoolbot
Copy link
Contributor Author

Original Redmine Comment
Author Name: Wilson Snyder (@wsnyder)
Original Date: 2012-04-15T19:45:25Z

Pushed to git. I disabled HAS_DOT, as after an hour it was only maybe 20% done.

@veripoolbot
Copy link
Contributor Author

Original Redmine Comment
Author Name: Jeremy Bennett (@jeremybennett)
Original Date: 2012-04-16T08:00:33Z

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.

@veripoolbot veripoolbot added area: documentation Issue involves documentation resolution: fixed Closed; fixed labels Dec 22, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area: documentation Issue involves documentation resolution: fixed Closed; fixed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@veripoolbot