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 Pcap++ documentation to use triple-slash doxygen format. #1660

Merged
merged 13 commits into from
Jan 8, 2025

Conversation

Dimi1010
Copy link
Collaborator

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

Copy link

codecov bot commented Dec 17, 2024

Codecov Report

Attention: Patch coverage is 87.50000% with 1 line in your changes missing coverage. Please review.

Project coverage is 83.15%. Comparing base (7898a5d) to head (d07bf3d).
Report is 2 commits behind head on dev.

Files with missing lines Patch % Lines
Pcap++/header/PcapRemoteDevice.h 0.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##              dev    #1660      +/-   ##
==========================================
- Coverage   83.16%   83.15%   -0.02%     
==========================================
  Files         277      277              
  Lines       48201    48193       -8     
  Branches     9932     9969      +37     
==========================================
- Hits        40086    40073      -13     
+ Misses       7266     7244      -22     
- Partials      849      876      +27     
Flag Coverage Δ
alpine320 75.16% <80.00%> (+<0.01%) ⬆️
fedora40 75.20% <80.00%> (+0.02%) ⬆️
macos-13 80.65% <71.42%> (-0.01%) ⬇️
macos-14 80.65% <71.42%> (-0.01%) ⬇️
macos-15 80.62% <71.42%> (-0.01%) ⬇️
mingw32 70.89% <66.66%> (-0.03%) ⬇️
mingw64 70.84% <66.66%> (-0.05%) ⬇️
npcap 85.30% <83.33%> (-0.02%) ⬇️
rhel94 75.02% <80.00%> (-0.01%) ⬇️
ubuntu2004 58.60% <80.00%> (-0.03%) ⬇️
ubuntu2004-zstd 58.74% <80.00%> (+0.01%) ⬆️
ubuntu2204 74.97% <80.00%> (+<0.01%) ⬆️
ubuntu2204-icpx 61.40% <57.14%> (-0.04%) ⬇️
ubuntu2404 75.22% <80.00%> (+<0.01%) ⬆️
unittest 83.15% <87.50%> (-0.02%) ⬇️
windows-2019 85.33% <83.33%> (-0.02%) ⬇️
windows-2022 85.36% <83.33%> (-0.02%) ⬇️
winpcap 85.32% <83.33%> (-0.01%) ⬇️
xdp 50.54% <20.00%> (+<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.

@Dimi1010 Dimi1010 marked this pull request as ready for review December 17, 2024 23:21
@Dimi1010 Dimi1010 requested a review from seladb as a code owner December 17, 2024 23:21
Copy link
Collaborator

@tigercosmos tigercosmos left a comment

Choose a reason for hiding this comment

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

LGTM

Pcap++/header/DpdkDevice.h Outdated Show resolved Hide resolved
Pcap++/header/DpdkDevice.h Outdated Show resolved Hide resolved
Pcap++/header/DpdkDeviceList.h Outdated Show resolved Hide resolved
Pcap++/header/KniDevice.h Outdated Show resolved Hide resolved
Pcap++/header/KniDevice.h Outdated Show resolved Hide resolved
Pcap++/header/KniDeviceList.h Outdated Show resolved Hide resolved
Pcap++/header/KniDeviceList.h Outdated Show resolved Hide resolved
Pcap++/header/KniDeviceList.h Outdated Show resolved Hide resolved
Pcap++/header/RawSocketDevice.h Outdated Show resolved Hide resolved
Pcap++/header/XdpDevice.h Outdated Show resolved Hide resolved
@Dimi1010 Dimi1010 requested a review from seladb January 5, 2025 09:55
@Dimi1010 Dimi1010 merged commit 91d2058 into seladb:dev Jan 8, 2025
41 checks passed
@Dimi1010 Dimi1010 deleted the refactor/triple-slash-docs-pcpp branch January 8, 2025 04:02
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.

3 participants