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

Add Doxygen comments to all public functions #260

Open
ChrisThrasher opened this issue Sep 26, 2023 · 0 comments
Open

Add Doxygen comments to all public functions #260

ChrisThrasher opened this issue Sep 26, 2023 · 0 comments

Comments

@ChrisThrasher
Copy link
Member

ChrisThrasher commented Sep 26, 2023

A first step towards improved documentation should come in the form of writing Doxygen headers above all public functions. This will get readers more information on what each function does.

Eventually I'd like to create a static documentation website based on these. I've already done this for another repo of mine here so I know it can be done entirely via free GitHub services.

Let's target 2.6.x for this so that both v2 and v3 can benefit from it. Only one function in v2 is not present in v3 so this will not be difficult to do.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant