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.

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

Doxygen documentation #1302

Closed
veripoolbot opened this issue Apr 18, 2018 · 2 comments
Closed

Doxygen documentation #1302

veripoolbot opened this issue Apr 18, 2018 · 2 comments

Comments

@veripoolbot
Copy link

@veripoolbot veripoolbot commented Apr 18, 2018


Author Name: Stefan Wallentowitz (@wallento)
Original Redmine Issue: 1302 from https://www.veripool.org

Original Assignee: Stefan Wallentowitz (@wallento)


Hi Wilson,

I have started looking in some things to do in Verilator and I am still on the learning curve for the codebase :)

I was thinking to add documentation to whatever code I read and understood. As part of this I am wondering if you are interested in me putting some doxygen documentation to the classes and functions. This will take a long time, but I would be happy to do my best.

If you think this is good and have any suggestions about style etc. I am happy to follow your proposal.

Cheers,
Stefan

@veripoolbot

This comment has been minimized.

Copy link
Author

@veripoolbot veripoolbot commented Apr 19, 2018


Original Redmine Comment
Author Name: Wilson Snyder (@wsnyder)
Original Date: 2018-04-19T14:09:45Z


Doxygen fixups are welcome, however note the develop-v4 branch should be used for major updates.

Please however keep the comments of reasonable length - the kernel is a good example of reasonable verbosity. What I want to avoid is a huge line count increase which greatly decreases what fits on a screen.

I'd suggest the include/ directory would be the highest value target. Maybe make a few edits for feedback before going wholesale?

@veripoolbot

This comment has been minimized.

Copy link
Author

@veripoolbot veripoolbot commented Oct 8, 2018


Original Redmine Comment
Author Name: Wilson Snyder (@wsnyder)
Original Date: 2018-10-08T11:26:39Z


As noted earlier, we welcome patches in documentation, but seems unnecessary to leave a bug open for a long time on this as isn't a problem/feature.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
1 participant
You can’t perform that action at this time.