From 55fe4a464f1bcc7f17c3c97558fc284c6472b20e Mon Sep 17 00:00:00 2001 From: Akshai M Date: Fri, 4 Sep 2020 16:24:58 +0530 Subject: [PATCH] net/sock : Update documentation Added net_sock_conf super group and updated sock_util to the super group. --- sys/include/net/sock/util.h | 5 +---- sys/net/sock/doc.txt | 11 +++++++++++ 2 files changed, 12 insertions(+), 4 deletions(-) create mode 100644 sys/net/sock/doc.txt diff --git a/sys/include/net/sock/util.h b/sys/include/net/sock/util.h index 1bb32a797f..9f5336a34b 100644 --- a/sys/include/net/sock/util.h +++ b/sys/include/net/sock/util.h @@ -206,11 +206,9 @@ static inline bool sock_udp_ep_equal(const sock_udp_ep_t *a, /** * @defgroup net_sock_util_conf SOCK utility functions compile configurations - * @ingroup net_sock_util - * @ingroup config + * @ingroup net_sock_conf * @{ */ - /** * @brief maximum length of the scheme part for sock_urlsplit. * @@ -233,7 +231,6 @@ static inline bool sock_udp_ep_equal(const sock_udp_ep_t *a, #ifndef CONFIG_SOCK_URLPATH_MAXLEN #define CONFIG_SOCK_URLPATH_MAXLEN (64U) #endif - /** @} */ #ifdef __cplusplus diff --git a/sys/net/sock/doc.txt b/sys/net/sock/doc.txt new file mode 100644 index 0000000000..cfbe1343ee --- /dev/null +++ b/sys/net/sock/doc.txt @@ -0,0 +1,11 @@ +# Copyright (c) 2020 Freie Universitaet Berlin +# +# This file is subject to the terms and conditions of the GNU Lesser +# General Public License v2.1. See the file LICENSE in the top level +# directory for more details. +# +/** + * @defgroup net_sock_conf SOCK compile configurations + * @ingroup config + * @brief Group of compile time configurations related to SOCK + */