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

Open
wants to merge 22 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.11%. Comparing base (d60c699) to head (3c9b754).

Additional details and impacted files
@@            Coverage Diff             @@
##              dev    #1659      +/-   ##
==========================================
- Coverage   83.11%   83.11%   -0.01%     
==========================================
  Files         277      277              
  Lines       48207    48206       -1     
  Branches    10192     9925     -267     
==========================================
- Hits        40069    40066       -3     
- Misses       7243     7246       +3     
+ Partials      895      894       -1     
Flag Coverage Δ
alpine320 75.10% <ø> (-0.01%) ⬇️
fedora40 75.12% <ø> (-0.04%) ⬇️
macos-13 80.62% <ø> (ø)
macos-14 80.62% <ø> (+<0.01%) ⬆️
macos-15 80.59% <ø> (ø)
mingw32 70.83% <ø> (-0.04%) ⬇️
mingw64 70.79% <ø> (-0.04%) ⬇️
npcap 85.24% <ø> (-0.02%) ⬇️
rhel94 74.97% <ø> (-0.01%) ⬇️
ubuntu2004 58.59% <ø> (+<0.01%) ⬆️
ubuntu2004-zstd 58.68% <ø> (+<0.01%) ⬆️
ubuntu2204 74.89% <ø> (-0.01%) ⬇️
ubuntu2204-icpx 61.45% <ø> (ø)
ubuntu2404 75.17% <ø> (+0.01%) ⬆️
unittest 83.11% <ø> (-0.01%) ⬇️
windows-2019 85.27% <ø> (-0.01%) ⬇️
windows-2022 85.30% <ø> (-0.01%) ⬇️
winpcap 85.26% <ø> (ø)
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
@Dimi1010 Dimi1010 force-pushed the refactor/triple-slash-docs-packet branch from a28a062 to 8d2a6e3 Compare January 9, 2025 20:13
@Dimi1010 Dimi1010 force-pushed the refactor/triple-slash-docs-packet branch from 8d2a6e3 to 87ff355 Compare January 9, 2025 20:15
@Dimi1010
Copy link
Collaborator Author

Dimi1010 commented Jan 9, 2025

Ok, minor issue with the reformatting.
There are some @verbatim blocks that don't like working well with the /// format, and I am not sure how to deal with that...
The issues are that I am unsure if the /// will show in the actual verbatim text and the /// block needs to be unbroken with those lines to count as a single block. Also, I am getting a parser error in the SSLLayer so the parser may also be getting confused.

So unless anyone has ideas, I guess, we have 3 options.

cc: @seladb @tigercosmos

This was referenced Jan 17, 2025
@Dimi1010
Copy link
Collaborator Author

Dimi1010 commented Jan 17, 2025

Discontinued due to issues with doxygen parsing of verbatim example blocks.

@Dimi1010 Dimi1010 closed this Jan 17, 2025
@Dimi1010 Dimi1010 reopened this Jan 18, 2025
@Dimi1010 Dimi1010 force-pushed the refactor/triple-slash-docs-packet branch from 785d2cb to fc84dc9 Compare January 18, 2025 21:44
@Dimi1010
Copy link
Collaborator Author

Fix seems to work. Thanks @egecetin .

@Dimi1010 Dimi1010 marked this pull request as ready for review January 19, 2025 07:10
@Dimi1010 Dimi1010 requested a review from seladb as a code owner January 19, 2025 07:10
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