Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Complete initial reference documentation #152

Merged
merged 5 commits into from
Aug 3, 2024
Merged

Conversation

ntadej
Copy link
Collaborator

@ntadej ntadej commented Aug 2, 2024

Complete initial reference documentation:

  • add widgets documentation
  • add location documentation -> this is done manually using dummy placeholder QML files and doxyqml
  • make sure include headers are hinted for all public C++ classes

@ntadej ntadej requested review from louwers, HarelM and birkskyum August 2, 2024 20:18
Copy link

codecov bot commented Aug 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 45.36%. Comparing base (020e3bc) to head (c6d0f25).
Report is 13 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #152      +/-   ##
==========================================
+ Coverage   45.27%   45.36%   +0.09%     
==========================================
  Files          35       35              
  Lines        2125     2147      +22     
==========================================
+ Hits          962      974      +12     
- Misses       1163     1173      +10     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link

@HarelM HarelM left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks very manual, I would consider automating some of the things here somehow...

@ntadej
Copy link
Collaborator Author

ntadej commented Aug 2, 2024

Looks very manual, I would consider automating some of the things here somehow...

Quick investigation did not yield any automated tools. There is QDoc provided by Qt, but I had very hard time to get anything useful out of it. For now I think this is sensible enough, but I'll keep investigating if something (semi)automated is possible.

@ntadej ntadej merged commit a311de2 into maplibre:main Aug 3, 2024
40 checks passed
@ntadej ntadej deleted the docs branch August 3, 2024 13:00
@ntadej ntadej added this to the 3.0 milestone Oct 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants