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 #2

Open
oysteijo opened this issue Apr 26, 2019 · 2 comments
Open

Add documentation #2

oysteijo opened this issue Apr 26, 2019 · 2 comments
Labels
documentation help wanted

Comments

@oysteijo
Copy link
Owner

oysteijo commented Apr 26, 2019 •
edited
Loading

There isn't much documentation. Maybe the add docstrings to the functions, and create something with Doxygen.
@oysteijo
Copy link
Owner Author

Doxygen may be a bit of an overkill! Maybe just make some markdown?

@oysteijo
Copy link
Owner Author

Is there something simpler than Doxygen available?
There isn't much to to document, maybe just write up a single document in markdown?

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

No branches or pull requests
1 participant
@oysteijo