-
Notifications
You must be signed in to change notification settings - Fork 433
Closed
Labels
🚨This issue needs some love.This issue needs some love.triage meI really want to be triaged.I really want to be triaged.
Milestone
Description
Users shouldn't have to read the header files to understand the API; this project should provide the equivalent of Javadoc for users to explore easily via their browser.
C++ has several API documentation autogeneration options:
- Doxygen, possibly the most popular / well-known for C++
- cldoc, based on Clang, rumored to be unmaintained based on commit history
- Standardese — claims to be "nextgen Doxygen" but is experimental, so maybe not ready for us to use yet
- other options listed on Wikipedia
Also, other Google Cloud client library projects have a landing page, and publish docs to a central location, so this repo should also follow suit. For example, here are a few sites for existing APIs:
- http://googlecloudplatform.github.io/google-cloud-go/#/
- https://googlecloudplatform.github.io/google-cloud-node/#/
- https://googlecloudplatform.github.io/google-cloud-python/
Metadata
Metadata
Assignees
Labels
🚨This issue needs some love.This issue needs some love.triage meI really want to be triaged.I really want to be triaged.