Project

General

Profile

[logo] 
 
Home
News
Activity
About/Contact
Major Tools
  Dinotrace
  Verilator
  Verilog-mode
  Verilog-Perl
Other Tools
  IPC::Locker
  Parallel::Forker
  Voneline
General Info
  Papers

Issue #1302

Doxygen documentation

Added by Stefan Wallentowitz over 1 year ago. Updated about 1 year ago.

Status:
NoFixNeeded
Priority:
Low
Category:
Documentation
% Done:

0%


Description

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

History

#1 Updated by Wilson Snyder over 1 year ago

  • Category set to Documentation
  • Status changed from New to Assigned
  • Assignee set to Stefan Wallentowitz

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?

#2 Updated by Wilson Snyder about 1 year ago

  • Status changed from Assigned to NoFixNeeded

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.

Also available in: Atom