Docs: Initial Doxygen-based documentation for QMapLibre Core #99
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAttention:
Additional details and impacted files@@ 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 ☔ View full report in Codecov by Sentry. |
|
Tagging also @cgalvan. |
|
Doxygen is what maplibre-native uses right? |
|
I think so, yes. It is very standard for C++ projects. |
birkskyum
approved these changes
Jan 28, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Initial Doxygen-based documentation for
QMapLibreCore. 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
qdocthis 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.