Skip to content

Commit 3827a9b

Browse files
Dimi1010Dimi1010
committed
Replaced verbatim blocks with @code{.unparsed} as per this workaround.
https://web.archive.org/web/20240724083629/https://technicalwriting.dev/src/verbatim-wrangling.html
1 parent 87ff355 commit 3827a9b

5 files changed

Lines changed: 20 additions & 26 deletions

File tree

‎Packet++/header/Layer.h‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ namespace pcpp
4141
/// to the relevant place in the packet. The layer sees all the data from this pointer forward until the end of the
4242
/// packet. Here is an example packet showing this concept:
4343
///
44-
/// @verbatim
44+
/// @code{.unparsed}
4545
/// ====================================================
4646
/// |Eth |IPv4 |TCP |Packet |
4747
/// |Header |Header |Header |Payload |
@@ -55,7 +55,7 @@ namespace pcpp
5555
/// TcpLayer data
5656
/// |----------------|
5757
/// PayloadLayer data
58-
/// @endverbatim
58+
/// @endcode
5959
class Layer : public IDataContainer
6060
{
6161
friend class Packet;

‎Packet++/header/NtpLayer.h‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ namespace pcpp
1818
/// v4), and an optional message authentication code (MAC). Currently the extension fields are not supported. The
1919
/// NTP header is:
2020
///
21-
/// @verbatim
21+
/// @code{.unparsed}
2222
/// 0 1 2 3
2323
/// 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
2424
/// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
@@ -64,7 +64,7 @@ namespace pcpp
6464
/// | dgst (128 for v4, 64 for v3) |
6565
/// | |
6666
/// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
67-
/// @endverbatim
67+
/// @endcode
6868
class NtpLayer : public Layer
6969
{
7070
private:

‎Packet++/header/SSHLayer.h‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
/// Following is an overview of the SSH protocol classes currently supported in PcapPlusPlus. They cover the different
2020
/// messages of the SSH protocol:
2121
///
22-
/// @verbatim
22+
/// @code{.unparsed}
2323
/// +----------------------------+ SSH version identification
2424
/// +---| SSHIdentificationMessage | ===> as described here:
2525
/// | +----------------------------+ https://tools.ietf.org/html/rfc4253#section-4.2
@@ -37,7 +37,7 @@
3737
/// +---| SSHEncryptedMessage | ===> An encrypted SSH message
3838
/// +----------------------------+
3939
///
40-
/// @endverbatim
40+
/// @endcode
4141
/// The following points describe the heuristics for deciding the
4242
/// message type for each packet:
4343
/// 1. If the data starts with the characters "SSH-" and ends with
@@ -166,13 +166,13 @@ namespace pcpp
166166
/// A class representing all of the non-encrypted SSH handshake messages.
167167
/// An handshake message typically has the following structure:
168168
///
169-
/// @verbatim
169+
/// @code{.unparsed}
170170
/// 0 1 2 3 4 5 6
171171
/// +---------+---------+---------+---------+---------+---------+----------- ---------+
172172
/// | Packet Length | Padding | Message | Message .... Padding |
173173
/// | | Length | Type | Content .... |
174174
/// +---------------------------------------+---------+---------+----------- ---------+
175-
/// @endverbatim
175+
/// @endcode
176176
///
177177
/// The first 4 bytes hold the packet length, followed by 1 byte that holds the padding length (which comes at the
178178
/// end of the message), then 1 byte that holds the message type (which can be of type

‎Packet++/header/SSLLayer.h‎

Lines changed: 10 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,7 @@
3232
/// pcpp::SSLLayer. The pcpp::SSLLayer is an abstract class which cannot be instantiated. Only its 4 derived classes can
3333
/// be instantiated. This means you'll never see a layer of type pcpp::SSLLayer, you'll only see the type of the derived
3434
/// classes. A basic class diagram looks like this:
35-
/// @verbatim
36-
///
35+
/// @code{.unparsed}
3736
/// ╔═════════════════════════════════════════════════════════════════════════════════════════════════╗
3837
/// ║ +----------------------------+ ║
3938
/// ║ +---| SSLHandshakeLayer | ===> Handshake record type ║
@@ -51,13 +50,12 @@
5150
/// ║ +---| SSLApplicationDataLayer | ===> Application data record type ║
5251
/// ║ +----------------------------+ ║
5352
/// ╚═════════════════════════════════════════════════════════════════════════════════════════════════╝
54-
/// @endverbatim
53+
/// @endcode
5554
///
5655
/// A single packet may include several SSL/TLS records, meaning
5756
/// several layer instances of these types, for example:
5857
///
59-
/// @verbatim
60-
///
58+
/// @code{.unparsed}
6159
/// ╔══════════════════════════════════════════════════════════════════════════════╗
6260
/// ║ +--------------------------+ ║
6361
/// ║ | EthLayer | ║
@@ -73,7 +71,7 @@
7371
/// ║ | SSLHandshakeLayer | / ║
7472
/// ║ +--------------------------+ ║
7573
/// ╚══════════════════════════════════════════════════════════════════════════════╝
76-
/// @endverbatim
74+
/// @endcode
7775
///
7876
/// <BR><BR>
7977
///
@@ -107,8 +105,7 @@
107105
/// them reside in SSLHandshake.h. Following is a simple diagram of these
108106
/// classes:
109107
///
110-
/// @verbatim
111-
///
108+
/// @code{.unparsed}
112109
/// ╔════════════════════════════════════════════════════════════════════════════════════════════════════════════════╗
113110
/// ║ SSLHandshakeMessage ║
114111
/// ║ | ║
@@ -134,7 +131,7 @@
134131
/// ║ | ║
135132
/// ║ |---SSLNewSessionTicketMessage ==> New-session-ticket message ║
136133
/// ╚════════════════════════════════════════════════════════════════════════════════════════════════════════════════╝
137-
/// @endverbatim
134+
/// @endcode
138135
///
139136
/// In addition, for all handshake messages which aren't supported in PcapPlusPlus or for encrypted
140137
/// handshake messages There is another class: pcpp::SSLUnknownMessage
@@ -279,8 +276,7 @@ namespace pcpp
279276
/// demonstrates). But there are cases a layer may contain more than 1 message. To better explain this layer
280277
/// structure. We'll use 2 examples. The first will be client-hello message. The layer structure will look like this:
281278
///
282-
/// @verbatim
283-
///
279+
/// @code{.unparsed}
284280
/// ╔══════════════════════════════════════════════════════════════════════════════════════════╗
285281
/// ║ |------------------- SSLHandshakeLayer ----------------------| ║
286282
/// ║ +----------------------+-------------------------------------+ ║
@@ -296,14 +292,12 @@ namespace pcpp
296292
/// ║ TLS1_2 length ║
297293
/// ║ | yyy ║
298294
/// ╚══════════════════════════════════════════════════════════════════════════════════════════╝
299-
///
300-
/// @endverbatim
295+
/// @endcode
301296
///
302297
/// Second example is a multiple-message handshake layer comprises of server-hello, certificate and
303298
/// server-key-exchange messages:
304299
///
305-
/// @verbatim
306-
///
300+
/// @code{.unparsed}
307301
/// ╔═════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════╗
308302
/// ║ |---------------------------------------------- SSLHandshakeLayer -----------------------------------------------------| ║
309303
/// ║ +----------------------+-------------------------------------+---------------------------+-----------------------------+ ║
@@ -317,7 +311,7 @@ namespace pcpp
317311
/// ║ SSL_HANDSHAKE length handshake SSL_CERTIFICATE SSL_SERVER_KEY_EXCHANGE ║
318312
/// ║ (22) xxx | version,length | | ║
319313
/// ╚═════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════╝
320-
/// @endverbatim
314+
/// @endcode
321315
// clang-format on
322316
#ifdef __GNUC__
323317
# pragma GCC diagnostic pop

‎Packet++/header/VlanLayer.h‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,13 @@ namespace pcpp
1414
#pragma pack(push, 1)
1515
struct vlan_header
1616
{
17-
/// @verbatim
17+
/// @code{.unparsed}
1818
/// 0 1 2
1919
/// 0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7 0
2020
/// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
2121
/// |Prio |C| VLAN ID |
2222
/// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
23-
/// @endverbatim
23+
/// @endcode
2424
uint16_t vlan;
2525
/// Ethernet type for next layer
2626
uint16_t etherType;

0 commit comments

Comments
 (0)