search

CesiumGS / cesium-native

Apache License 2.0
435 stars 214 forks source link

Fix Documentation CI task #983

Open j9liu opened 1 week ago

j9liu commented 1 week ago

Currently the Documentation CI task takes a while because it builds all the vcpkg dependencies unnecessarily. Fixing this will make the steps below faster.

j9liu commented 1 week ago

Forgot to include: we should also review Doxygen log and fix problems it reports.

Additionally, we should change CI Documentation task to fail on Doxygen errors so that we avoid them going forward.

kring commented 1 day ago

I wanted to mention a cool feature while I'm thinking about it, because I almost forgot about it myself. We have the ability to pull examples from tests and include them in the generated docs. Which is pretty nice because it allows us to make sure the examples compile and even function correctly. See the docs for the Plane constructors for an example: https://cesium.com/learn/cesium-native/ref-doc/classCesiumGeometry_1_1Plane.html#a80cb61ea891fe39d6468eca8dbb67291