Some projects have the requirement for API document, so this page will collect the information for those projects have API document.
API document contains details on the component’s API. There are some good tools to help generate API document.
- Doxygen: it is the defacto standard tool for generating documentation from annotated C++ sources, but it also supports other popular programming languages such as C, Objective-C, C#, PHP, Java, Python, IDL (Corba, Microsoft, and UNO/OpenOffice flavors), Fortran, VHDL, Tcl, and to some extent D. http://www.doxygen.nl/
- Swagger: Simplify API development for users, teams, and enterprises with the Swagger open source and professional toolset. Find out how Swagger can help you design and document your APIs at scale. Good for converting yaml and restful API format files to doucment. https://swagger.io/
Please fill in your project and repo information if you have API document.
| Project | repo | Note |
|---|---|---|
| DOC | doc | create API document homepage. |
| O-DU low | create API document page for O-DU Low | |
| NONRTRIC | https://gerrit.o-ran-sc.org/r/gitweb?p=nonrtric.git;a=summary https://gerrit.o-ran-sc.org/r/gitweb?p=sim%2Fa1-interface.git;a=summary | https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric/en/latest/ https://docs.o-ran-sc.org/projects/o-ran-sc-sim-a1-interface/en/latest/ |