Doxygen: add missing module descriptions

diff --git a/doc/doxygen/Doxy.page.h b/doc/doxygen/Doxy.page.h
index 65bfa3fc91b4927941684349823867e5cd0314c5..7c1bd89e88f4d6b94605c5320eafc6ca86a7f21a 100644 (file)
--- a/doc/doxygen/Doxy.page.h
+++ b/doc/doxygen/Doxy.page.h
@@ -30,6 +30,7 @@
  - \ref rrtype    — DNS resource record types
  - \ref knot-tsig — TSIG operations
  - \ref wire      — Packet wire data manipulation
+ - \ref xdp       — XDP interface
  - \ref yparser   — Simple YAML parser
 
 \defgroup ctl        ctl
@@ -40,6 +41,7 @@
 \defgroup rrtype     rrtype
 \defgroup knot-tsig  tsig
 \defgroup wire       wire
+\defgroup xdp        xdp
 \defgroup yparser    yparser
 
 

diff --git a/src/libknot/descriptor.h b/src/libknot/descriptor.h
index 738694e0f5d27844265017f3998cf79606e93086..07085b4e717bad91e9aaf6bd744b32f5b36e15b6 100644 (file)
--- a/src/libknot/descriptor.h
+++ b/src/libknot/descriptor.h
@@ -1,4 +1,4 @@
-/*  Copyright (C) 2019 CZ.NIC, z.s.p.o. <knot-dns@labs.nic.cz>
+/*  Copyright (C) 2021 CZ.NIC, z.s.p.o. <knot-dns@labs.nic.cz>
 
     This program is free software: you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -17,6 +17,8 @@
 /*!
  * \file
  *
+ * \brief DNS resource record descriptions.
+ *
  * \addtogroup rr
  * @{
  */

diff --git a/src/libknot/xdp/bpf-consts.h b/src/libknot/xdp/bpf-consts.h
index 25545f9902d6319313339b4076e9446626611174..3e24756ca3fc3d9ea4420b65a7ef94e08152222e 100644 (file)
--- a/src/libknot/xdp/bpf-consts.h
+++ b/src/libknot/xdp/bpf-consts.h
@@ -14,6 +14,15 @@
     along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
+/*!
+ * \file
+ *
+ * \brief XDP filter constants.
+ *
+ * \addtogroup xdp
+ * @{
+ */
+
 #pragma once
 
 enum {
@@ -23,3 +32,5 @@ enum {
        KNOT_XDP_LISTEN_PORT_DROP  = 1 << 18,    /*!< Drop incoming messages to ports >= port value. */
        KNOT_XDP_LISTEN_PORT_ROUTE = 1 << 19,    /*!< Consider routing information from kernel. */
 };
+
+/*! @} */

diff --git a/src/libknot/xdp/bpf-user.h b/src/libknot/xdp/bpf-user.h
index ce30582aaedc3e2ae657eb86de0484c40f42ddbb..479673273aa78349376ab33fc681faca3d9ff800 100644 (file)
--- a/src/libknot/xdp/bpf-user.h
+++ b/src/libknot/xdp/bpf-user.h
@@ -14,6 +14,15 @@
     along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
+/*!
+ * \file
+ *
+ * \brief XDP socket interface.
+ *
+ * \addtogroup xdp
+ * @{
+ */
+
 #pragma once
 
 #include <bpf/xsk.h>
@@ -110,3 +119,5 @@ int kxsk_socket_start(const struct kxsk_iface *iface, uint32_t listen_port,
  * \param iface  Interface context.
  */
 void kxsk_socket_stop(const struct kxsk_iface *iface);
+
+/*! @} */

diff --git a/src/libknot/xdp/eth.h b/src/libknot/xdp/eth.h
index b1c185d1cc08431bfca5e1f9a09f849c36573e45..d6fd319db4f9011527c4c74f20536dafb6b60780 100644 (file)
--- a/src/libknot/xdp/eth.h
+++ b/src/libknot/xdp/eth.h
@@ -14,6 +14,15 @@
     along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
+/*!
+ * \file
+ *
+ * \brief Ethernet device info interface.
+ *
+ * \addtogroup xdp
+ * @{
+ */
+
 #pragma once
 
 #include <stddef.h>
@@ -67,3 +76,5 @@ typedef enum {
  * \return Current XDP mode.
  */
 knot_xdp_mode_t knot_eth_xdp_mode(int if_index);
+
+/*! @} */

diff --git a/src/libknot/xdp/msg.h b/src/libknot/xdp/msg.h
index 179abf86299f82407e29afae65a08882d9c20d70..ff41420265208e6c34aca3fbe6af7a6904b7c770 100644 (file)
--- a/src/libknot/xdp/msg.h
+++ b/src/libknot/xdp/msg.h
@@ -14,6 +14,15 @@
     along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
+/*!
+ * \file
+ *
+ * \brief XDP message description.
+ *
+ * \addtogroup xdp
+ * @{
+ */
+
 #pragma once
 
 #include <stdint.h>
@@ -43,3 +52,5 @@ typedef struct knot_xdp_msg {
        uint32_t ackno;
        struct iovec payload;
 } knot_xdp_msg_t;
+
+/*! @} */

diff --git a/src/libknot/xdp/tcp.h b/src/libknot/xdp/tcp.h
index 47f7a0bfc5c9b1bc99a021cb37ee7e17747661b9..81d43d6666bdf1ea580a8729c662989625bf7b50 100644 (file)
--- a/src/libknot/xdp/tcp.h
+++ b/src/libknot/xdp/tcp.h
@@ -14,6 +14,15 @@
     along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
+/*!
+ * \file
+ *
+ * \brief TCP over XDP IO interface.
+ *
+ * \addtogroup xdp
+ * @{
+ */
+
 #pragma once
 
 #include "libknot/mm_ctx.h"
@@ -63,3 +72,5 @@ int knot_xdp_tcp_relay(knot_xdp_socket_t *socket, knot_xdp_msg_t msgs[],
  */
 int knot_xdp_tcp_send(knot_xdp_socket_t *socket, knot_tcp_relay_t relays[],
                       uint32_t relay_count);
+
+/*! @} */

diff --git a/src/libknot/xdp/xdp.h b/src/libknot/xdp/xdp.h
index 298f61e1dcf0585879615d24f982590870cae2bb..aa9ad644ef41b1ec5a0970ebef0ba953ca07fa1a 100644 (file)
--- a/src/libknot/xdp/xdp.h
+++ b/src/libknot/xdp/xdp.h
@@ -14,6 +14,15 @@
     along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
+/*!
+ * \file
+ *
+ * \brief XDP IO interface.
+ *
+ * \addtogroup xdp
+ * @{
+ */
+
 #pragma once
 
 #include <stdbool.h>
@@ -176,3 +185,5 @@ void knot_xdp_recv_finish(knot_xdp_socket_t *socket, const knot_xdp_msg_t msgs[]
  * \param file    Output file.
  */
 void knot_xdp_info(const knot_xdp_socket_t *socket, FILE *file);
+
+/*! @} */