search

maplibre / maplibre-native-qt

MapLibre Native Qt Bindings and Qt Location Plugin
https://maplibre.org/maplibre-native-qt/docs/
38 stars 14 forks source link

Docs: Initial Doxygen-based documentation for QMapLibre Core #99

Closed ntadej closed 8 months ago

ntadej commented 9 months ago

Initial Doxygen-based documentation for QMapLibre Core. This for now only covers reference documentation but in interest of keeping PRs manageable, I'm opening the first one already.

As I gave up on qdoc this mainly updates the existing documentation to Doxygen format and ensures everything is consistent.

Eventually we may want to publish this somewhere. To be discussed with @louwers how to do it properly.

codecov[bot] commented 9 months ago

Codecov Report

Attention: 38 lines in your changes are missing coverage. Please review.

Comparison is base (a70dd2a) 45.29% compared to head (3e5aa7b) 45.27%.

Files Patch % Lines
src/core/map.cpp 41.26% 37 Missing :warning:
src/core/settings.cpp 50.00% 1 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #99 +/- ## ========================================== - Coverage 45.29% 45.27% -0.03% ========================================== Files 35 35 Lines 2126 2125 -1 ========================================== - Hits 963 962 -1 Misses 1163 1163 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

ntadej commented 8 months ago

Tagging also @cgalvan.

birkskyum commented 8 months ago

Doxygen is what maplibre-native uses right?

ntadej commented 8 months ago

I think so, yes. It is very standard for C++ projects.