botan icon indicating copy to clipboard operation
botan copied to clipboard

Doc: Render <module_info> into Doxygen

Open reneme opened this issue 1 year ago • 1 comments

This is based on the <module_info> tags added before and renders that information into Doxygen. The results are similar to last month's previous draft PR but using the Virtual modules, the tree view of modules now makes a lot more sense.

Main "Modules" list

Screenshot 2022-08-08 161432

Module Descriptions

Modules have a "Details" page that list all their sub-modules, dependencies and also marks Virtual and Internal modules as such.

Screenshot 2022-08-08 161633

reneme avatar Aug 08 '22 14:08 reneme

Codecov Report

Base: 92.55% // Head: 92.57% // Increases project coverage by +0.02% :tada:

Coverage data is based on head (44ed9b9) compared to base (4021ef5). Patch has no changes to coverable lines.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #3033      +/-   ##
==========================================
+ Coverage   92.55%   92.57%   +0.02%     
==========================================
  Files         596      596              
  Lines       69810    69810              
  Branches     6612     6612              
==========================================
+ Hits        64610    64629      +19     
+ Misses       5167     5148      -19     
  Partials       33       33              
Impacted Files Coverage Δ
src/lib/utils/thread_utils/semaphore.cpp 69.23% <0.00%> (-30.77%) :arrow_down:
src/fuzzer/mode_padding.cpp 93.65% <0.00%> (-6.35%) :arrow_down:
src/cli/entropy.cpp 83.33% <0.00%> (-4.77%) :arrow_down:
src/lib/pk_pad/emsa_raw/emsa_raw.cpp 71.42% <0.00%> (-2.86%) :arrow_down:
src/lib/pubkey/dl_group/dl_group.cpp 91.22% <0.00%> (-1.06%) :arrow_down:
src/lib/tls/tls12/tls_channel_impl_12.cpp 88.79% <0.00%> (-0.29%) :arrow_down:
src/lib/pubkey/mce/mceliece_key.cpp 84.29% <0.00%> (+1.04%) :arrow_up:
src/cli/cli_rng.cpp 80.76% <0.00%> (+5.76%) :arrow_up:
src/lib/utils/cpuid/cpuid_x86.cpp 88.31% <0.00%> (+14.28%) :arrow_up:
src/lib/entropy/rdseed/rdseed.cpp 100.00% <0.00%> (+78.26%) :arrow_up:

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

:umbrella: View full report at Codecov.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.

codecov-commenter avatar Aug 08 '22 16:08 codecov-commenter

With #3032 merged I think this needs to be rebased

randombit avatar Sep 13 '22 21:09 randombit

With https://github.com/randombit/botan/pull/3032 merged I think this needs to be rebased

Done! I don't have my yubikey in reach, will sign and re-push once I'm home.

reneme avatar Sep 14 '22 07:09 reneme