Join GitHub today
GitHub is home to over 36 million developers working together to host and review code, manage projects, and build software together.Sign up
Determine C++ documentation standard #104
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.