You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
coverxygen is a tool that generates a documentation code coverage report from Doxygen's XML output. This coverage report can be fed to lcov or output in a summary by the tool itself. An example output from this tool, run on Cesium Native, looks like this:
Took a crack on setting this up in the coverxygen branch, but I've come to the conclusion that I'm not sure this tool will be very useful for our purposes. It helps identify private functions and fields that we haven't yet documented, but we could also toggle EXTRACT_PRIVATE in Doxygen to get the same warnings. Any public methods and fields we haven't documented are already treated as errors by Doxygen. Folks can take a look at the coverage report generated by the CI task in that branch to see if it seems worth it, but I lean towards not cluttering up our CI tasks adding new tools to the process for the sake of adding new tools.
coverxygen
is a tool that generates a documentation code coverage report from Doxygen's XML output. This coverage report can be fed tolcov
or output in a summary by the tool itself. An example output from this tool, run on Cesium Native, looks like this:It would be useful to have this tool around for Cesium Native, if not in CI then at least as a section in the developer's guide README.
The text was updated successfully, but these errors were encountered: