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

Reformat Packet++ documentation to use triple-slash doxygen format. #1659

Draft
wants to merge 13 commits into
base: dev
Choose a base branch
from

Conversation

Dimi1010
Copy link
Collaborator

Part of #1658
Includes reformatting of classes, structs and namespace documentation.

Copy link

codecov bot commented Dec 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.16%. Comparing base (f81ced2) to head (217a620).

Additional details and impacted files
@@            Coverage Diff             @@
##              dev    #1659      +/-   ##
==========================================
- Coverage   83.16%   83.16%   -0.01%     
==========================================
  Files         277      277              
  Lines       48193    48193              
  Branches     9966     9910      -56     
==========================================
- Hits        40080    40078       -2     
+ Misses       7234     7218      -16     
- Partials      879      897      +18     
Flag Coverage Δ
alpine320 75.16% <ø> (+<0.01%) ⬆️
fedora40 75.20% <ø> (+0.01%) ⬆️
macos-13 80.66% <ø> (+<0.01%) ⬆️
macos-14 80.66% <ø> (+<0.01%) ⬆️
macos-15 80.63% <ø> (ø)
mingw32 70.87% <ø> (-0.05%) ⬇️
mingw64 70.83% <ø> (-0.05%) ⬇️
npcap 85.30% <ø> (-0.02%) ⬇️
rhel94 75.05% <ø> (+0.02%) ⬆️
ubuntu2004 58.61% <ø> (-0.01%) ⬇️
ubuntu2004-zstd 58.75% <ø> (+0.01%) ⬆️
ubuntu2204 74.97% <ø> (+<0.01%) ⬆️
ubuntu2204-icpx 61.39% <ø> (-0.05%) ⬇️
ubuntu2404 75.20% <ø> (+<0.01%) ⬆️
unittest 83.16% <ø> (-0.01%) ⬇️
windows-2019 85.33% <ø> (-0.01%) ⬇️
windows-2022 85.36% <ø> (-0.01%) ⬇️
winpcap 85.33% <ø> (ø)
xdp 50.53% <ø> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

PS: Formatting ASCII drawings is annoying.
PS: Formating ASCII Drawings.
@Dimi1010 Dimi1010 force-pushed the refactor/triple-slash-docs-packet branch from 31cf265 to 3cc0e7c Compare December 17, 2024 06:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant