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

Determine C++ documentation standard #104

Open
seanmiddleditch opened this issue Jun 2, 2019 · 1 comment

Comments

Projects
None yet
1 participant
@seanmiddleditch
Copy link
Collaborator

commented Jun 2, 2019

Figure out what standard we want for documenting our APIs, which is a very-reasonable request from @Javioman.

Right now, most code just ins't documented at all, which is fairly uncool.

We need to decide what technology we want to use for documentation and the accompanying documentation format.

A non-exhaustive list of options:

Whichever we choose, we should aim for an ability to easily write high-quality documentation, getting clean output (preferably something we can auto-publish from master!), an ability to add tests that code is easonably documented by some criteria, and all with a minimum of effort for further maintenance.

@seanmiddleditch seanmiddleditch referenced this issue Jun 8, 2019

Merged

Doxygen #105

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.