Doc

kernel/include/net/ethernet_packet.hpp

@@ -16,20 +16,23 @@ namespace network {
 
 namespace ethernet {
 
+/*!
+ * \brief A packet on the ethernet layer
+ */
 struct packet {
     // Set from the beginning
-    char* payload;
+    char* payload;          ///< Pointer to the packet payload
-    size_t payload_size;
+    size_t payload_size;    ///< The size, in bytes, of the payload
 
     // Set by ethernet
-    ether_type type;
+    ether_type type;    ///< The type of ethernet
-    size_t index;
+    size_t index;       ///< The current index inside the packet
 
     // Set for user mode
-    size_t fd;
+    size_t fd; ///< The file descriptor (in user mode)
-    bool user;
+    bool user; ///< Flag indicating if the packet is a user packet or kernel packet
 
-    uint64_t tags; // This allows for 4 tags (4 layer)
+    uint64_t tags;          ///< Tags of the layer indices
     uint64_t interface;     ///< Id of the interface
 
     packet() : fd(0), user(false), tags(0) {}