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

Remove bundled libraries from doxygen #543

Merged
merged 1 commit into from
Feb 13, 2024

Conversation

gassmoeller
Copy link
Contributor

Currently all the bundled libraries are included in the doxygen documentation, which means it is hard to find the actual World Builder classes in the doxygen documentation (see https://codedocs.xyz/GeodynamicWorldBuilder/WorldBuilder/annotated.html). This change excludes all non WorldBuilder files from the doxygen documentation.

Copy link

codecov bot commented Feb 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (d465a69) 93.49% compared to head (0283a02) 93.49%.
Report is 5 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #543   +/-   ##
=======================================
  Coverage   93.49%   93.49%           
=======================================
  Files          92       92           
  Lines        6346     6346           
=======================================
  Hits         5933     5933           
  Misses        413      413           

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d465a69...0283a02. Read the comment docs.

Copy link

Benchmark Main Feature Difference (99.9% CI)
Slab interpolation simple none 1.025 ± 0.005 (s=454) 1.025 ± 0.003 (s=426) -0.1% .. +0.1%
Slab interpolation curved simple none 1.028 ± 0.004 (s=428) 1.029 ± 0.005 (s=450) -0.0% .. +0.2%
Spherical slab interpolation simple none 1.262 ± 0.009 (s=353) 1.262 ± 0.008 (s=363) -0.2% .. +0.2%
Slab interpolation simple curved CMS 1.096 ± 0.003 (s=402) 1.096 ± 0.002 (s=422) -0.1% .. +0.0%
Spherical slab interpolation simple CMS 1.861 ± 0.007 (s=254) 1.857 ± 0.006 (s=233) -0.3% .. -0.1%
Spherical fault interpolation simple none 1.271 ± 0.007 (s=370) 1.270 ± 0.007 (s=341) -0.2% .. +0.0%
Cartesian min max surface 2.370 ± 0.017 (s=177) 2.372 ± 0.017 (s=205) -0.2% .. +0.3%
Spherical min max surface 7.339 ± 0.012 (s=58) 7.343 ± 0.020 (s=67) -0.1% .. +0.2%

Copy link
Member

@MFraters MFraters left a comment

Choose a reason for hiding this comment

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

Thanks!

@MFraters MFraters merged commit 57c9c5d into GeodynamicWorldBuilder:main Feb 13, 2024
34 checks passed
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.

2 participants