You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
The text was updated successfully, but these errors were encountered:
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?
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
The text was updated successfully, but these errors were encountered: