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.

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

Move documentation to header #52

Open
LeSpocky opened this issue Nov 15, 2018 · 0 comments
Open

Move documentation to header #52

LeSpocky opened this issue Nov 15, 2018 · 0 comments
Labels
doc documentation

Comments

@LeSpocky
Copy link
Collaborator

A typical consumer of the library takes the header file(s) and some binaries, and can develop her application on top of that. If the API documentation would be included in the header as well, that would be sufficient, no need to look into things created by Doxygen or anything else. However Doxygen documentation can also be produced from the header instead of the source, it just does not matter. So be nice and move all the API documentation to the header file(s).

@LeSpocky LeSpocky added the doc documentation label Nov 15, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc documentation
Projects
None yet
Development

No branches or pull requests

1 participant