Skip to content

Commit

Permalink
Added empty lines around verbatim blocks to attempt to fix doxygen er…
Browse files Browse the repository at this point in the history 
…ror.
  • Loading branch information
@Dimi1010
Dimi1010 committed Jan 9, 2025
1 parent c3040c4 commit 8d2a6e3
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions Packet++/header/SSLLayer.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
/// be instantiated. This means you'll never see a layer of type pcpp::SSLLayer, you'll only see the type of the derived
/// classes. A basic class diagram looks like this:
/// @verbatim
///
/// ╔═════════════════════════════════════════════════════════════════════════════════════════════════╗
/// ║ +----------------------------+ ║
/// ║ +---| SSLHandshakeLayer | ===> Handshake record type ║
Expand All @@ -50,12 +51,14 @@
/// ║ +---| SSLApplicationDataLayer | ===> Application data record type ║
/// ║ +----------------------------+ ║
/// ╚═════════════════════════════════════════════════════════════════════════════════════════════════╝
///
/// @endverbatim
///
/// A single packet may include several SSL/TLS records, meaning
/// several layer instances of these types, for example:
///
/// @verbatim
///
/// ╔══════════════════════════════════════════════════════════════════════════════╗
/// ║ +--------------------------+ ║
/// ║ | EthLayer | ║
Expand All @@ -71,6 +74,7 @@
/// ║ | SSLHandshakeLayer | / ║
/// ║ +--------------------------+ ║
/// ╚══════════════════════════════════════════════════════════════════════════════╝
///
/// @endverbatim
///
/// <BR><BR>
Expand Down Expand Up @@ -106,6 +110,7 @@
/// classes:
///
/// @verbatim
///
/// ╔════════════════════════════════════════════════════════════════════════════════════════════════════════════════╗
/// ║ SSLHandshakeMessage ║
/// ║ | ║
Expand All @@ -131,6 +136,7 @@
/// ║ | ║
/// ║ |---SSLNewSessionTicketMessage ==> New-session-ticket message ║
/// ╚════════════════════════════════════════════════════════════════════════════════════════════════════════════════╝
///
/// @endverbatim
///
/// In addition, for all handshake messages which aren't supported in PcapPlusPlus or for encrypted
Expand Down Expand Up @@ -277,6 +283,7 @@ namespace pcpp
/// structure. We'll use 2 examples. The first will be client-hello message. The layer structure will look like this:
///
/// @verbatim
///
/// ╔══════════════════════════════════════════════════════════════════════════════════════════╗
/// ║ |------------------- SSLHandshakeLayer ----------------------| ║
/// ║ +----------------------+-------------------------------------+ ║
Expand All @@ -292,12 +299,14 @@ namespace pcpp
/// ║ TLS1_2 length ║
/// ║ | yyy ║
/// ╚══════════════════════════════════════════════════════════════════════════════════════════╝
///
/// @endverbatim
///
/// Second example is a multiple-message handshake layer comprises of server-hello, certificate and
/// server-key-exchange messages:
///
/// @verbatim
///
/// ╔═════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════╗
/// ║ |---------------------------------------------- SSLHandshakeLayer -----------------------------------------------------| ║
/// ║ +----------------------+-------------------------------------+---------------------------+-----------------------------+ ║
Expand All @@ -311,6 +320,7 @@ namespace pcpp
/// ║ SSL_HANDSHAKE length handshake SSL_CERTIFICATE SSL_SERVER_KEY_EXCHANGE ║
/// ║ (22) xxx | version,length | | ║
/// ╚═════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════╝
///
/// @endverbatim
// clang-format on
#ifdef __GNUC__
Expand Down

0 comments on commit 8d2a6e3

Please sign in to comment.