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

The hand-written classes should have documentation #74

Open
hzeller opened this issue Jan 15, 2020 · 2 comments
Open

The hand-written classes should have documentation #74

hzeller opened this issue Jan 15, 2020 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@hzeller
Copy link
Collaborator

hzeller commented Jan 15, 2020

The classes and functions in e.g. include/vpi_uhdm.h should have some documentation headers to understand the context and purpse.
@hzeller hzeller added the documentation Improvements or additions to documentation label Jan 15, 2020
@mithro
Copy link
Collaborator

mithro commented Jan 15, 2020

Please use sphinx compatible documentation (doxygen) in C headers.

I can help you set up breathe + exhale to auto generate documentation onto readthedocs.

@mithro
Copy link
Collaborator

mithro commented Jan 15, 2020

http://www.doxygen.nl/manual/docblocks.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@mithro @hzeller