CesiumGS / cesium-unreal

Bringing the 3D geospatial ecosystem to Unreal Engine
https://cesium.com/platform/cesium-for-unreal/
Apache License 2.0
945 stars 296 forks source link

Create C++ API reference #689

Open argallegos opened 2 years ago

argallegos commented 2 years ago

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? image

Originally from https://community.cesium.com/t/c-documentation/16168

argallegos commented 2 years ago

Another request for this from the forum.

creatio-ua commented 7 months ago

I'm unable to find the UE C++ API reference for Cesium. Would really love to have it.

azrogers commented 7 months ago

The C++ documentation isn't currently available online, but you can generate it by installing Doxygen and Node and running npm run doxygen in the cesium-unreal root directory, as listed here. You can do similar to generate the documentation for cesium-native (which Cesium for Unreal uses).