o3de / sig-docs-community

Resources for the Open 3D Engine Documentation & Community Special Interest Group (SIG)
Apache License 2.0
11 stars 9 forks source link

Roadmap: Improve the API Reference Generation #111

Open chanmosq opened 1 year ago

chanmosq commented 1 year ago

Summary

O3DE code base is documented using a doxygen-generated API reference. This roadmap item tracks work to improve the API reference generation tool and publish instructions on how to generate.

### Tasks
- [ ] https://github.com/o3de/sig-docs-community/issues/114
- [ ] https://github.com/o3de/o3de.org/issues/2012
- [ ] https://github.com/o3de/o3de.org/issues/2022
- [ ] Improve the main page of each API Reference. It should not appear empty, and provide guidance or navigation for the user. (Example of a main page: [Atom Core](https://www.o3de.org/docs/api/frameworks/atomcore/))

Related Links

Link to additional information such as RFC related to the roadmap item.


Learn more about O3DE roadmaps.