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

Add documentation to dos.h #35

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add documentation to dos.h #35

wants to merge 1 commit into from

Conversation

Enet4
Copy link

@Enet4 Enet4 commented Jul 26, 2022

Should hopefully resolve #23.

  • Documentation was added to each public facing symbol in dos.h. Most of it had already been written when I was working on dos-like-rs. Still, some validation on their accuracy would be much appreciated.
  • Added Doxyfile configuration file, for easy documentation generation. All you have to do is install Doxygen and run doxygen.
  • Updated .gitignore to ignore generated docs

@Enet4
Add documentation
ca1ce15 
- add documentation body
  to each public facing symbol in dos.h
- add Doxyfile configuration file,
  for easy documentation generation
- update .gitignore to ignore generated docs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

dos.h needs comments
1 participant
@Enet4