Changeset 87b490e3 in mainline for uspace/lib/pcap/include/pcap_dumper.h

Timestamp:

2024-12-13T08:44:05Z (15 months ago)

Author:

Nataliia Korop <n.corop08@…>

Children:

420b13d

Parents:

fb31682

git-author:

Nataliia Korop <n.corop08@…> (2024-11-30 19:08:32)

git-committer:

Nataliia Korop <n.corop08@…> (2024-12-13 08:44:05)

Message:

docs comments

File:

• uspace/lib/pcap/include/pcap_dumper.h (modified) (3 diffs)

uspace/lib/pcap/include/pcap_dumper.h

@@ -30 +30 @@
  * @{
  */
-/** @file pcap interface
+/** @file Pcap dumper. Structure is a part of every device that is in category PCAP and can dump packets.
  */
 
@@ -40 +40 @@
 #include "pcap.h"
 
+/** Packet dumper structure that is responsible for dumping packets. */
 typedef struct pcap_dumper {
         fibril_mutex_t mutex;
+        /** Flag that indicates, whether the packet should be dumped or ignored. */
         bool to_dump;
+        /** Writer structure that is responsible for writing data to the destination buffer. */
         pcap_writer_t writer;
 } pcap_dumper_t;
@@ -53 +56 @@
 
 #endif
+
 /** @}
  */