Publish Doxygen documentation online on release
azrogers opened this issue · comments
Similarly to CesiumGS/cesium-unreal#1377, we currently don't publish the Doxygen docs that we build for cesium-native. For the reasons listed in the linked issue, it would be a good move for us to publish the cesium-native docs online as well.
CC @AndieTursi
Summarizing here all the requests for API documentation that I could find.
First, on GitHub:
- #619 - "may I ask why I can't find a developer manual about Cesium Native?"
- CesiumGS/cesium-unreal#689 - "Cesium JS and the ion SDK have a documentation page like this available from the Learn menu. Can we create something like this for the C++ codebase for Cesium-Unreal?"
A few posts on the forum about Unreal documentation:
- Can you make a documentation like UE4 documentation
- Where can I find the c++ documentation without having to build it myself?
And many more about Unity documentation:
- Where can I find the API documentation for the Cesium for Unity package?
- Is there any relevant API documentation, such as which interfaces to call when I want to perform coordinate conversion
- Where can I find the documentation of Cesium components and their methods to program from C# scripts?
- Cesium for Unity documentation somewhere?
- Is there an api for unity
- Also where can i get unity c# documentation for cesium
- I also can’t find the API documentation for the CesiumUnity package so I have to read the source code to figure it out
- is there any link for Scripting API to help me learn the function of each script
Unity would take a bit more effort since we're not currently generating any documentation for the C# side of things. This would just require setting up Doxygen or DocFX as part of the build process. For Unreal and Native, we mostly just need to adapt the JSDoc template from CesiumJS to work for Doxygen - or grab an existing template and slap our logo on it.
Couldn't leave it for over the holiday - added Unity Doxygen support in CesiumGS/cesium-unity#471.