From a8b8b6403681abab898fd53e517867a071442306 Mon Sep 17 00:00:00 2001 From: Simon Brummer Date: Wed, 1 Feb 2017 16:33:31 +0100 Subject: [PATCH] gnrc_tcp: cleanup: update doxygen headers --- sys/include/net/gnrc/tcp.h | 6 +++--- sys/include/net/gnrc/tcp/config.h | 6 +++--- sys/include/net/gnrc/tcp/tcb.h | 6 +++--- sys/include/net/tcp.h | 4 ++-- sys/net/gnrc/transport_layer/tcp/gnrc_tcp.c | 6 +++--- sys/net/gnrc/transport_layer/tcp/gnrc_tcp_eventloop.c | 6 +++--- sys/net/gnrc/transport_layer/tcp/gnrc_tcp_fsm.c | 6 +++--- sys/net/gnrc/transport_layer/tcp/gnrc_tcp_option.c | 6 +++--- sys/net/gnrc/transport_layer/tcp/gnrc_tcp_pkt.c | 6 +++--- sys/net/gnrc/transport_layer/tcp/gnrc_tcp_rcvbuf.c | 7 ++++--- sys/net/gnrc/transport_layer/tcp/internal/common.h | 6 +++--- sys/net/gnrc/transport_layer/tcp/internal/eventloop.h | 6 +++--- sys/net/gnrc/transport_layer/tcp/internal/fsm.h | 6 +++--- sys/net/gnrc/transport_layer/tcp/internal/option.h | 6 +++--- sys/net/gnrc/transport_layer/tcp/internal/pkt.h | 6 +++--- sys/net/gnrc/transport_layer/tcp/internal/rcvbuf.h | 6 +++--- 16 files changed, 48 insertions(+), 47 deletions(-) diff --git a/sys/include/net/gnrc/tcp.h b/sys/include/net/gnrc/tcp.h index 052f078b66..5100f5c5aa 100644 --- a/sys/include/net/gnrc/tcp.h +++ b/sys/include/net/gnrc/tcp.h @@ -1,5 +1,5 @@ /* - * Copyright (C) 2015 Simon Brummer + * Copyright (C) 2017 Simon Brummer * * 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 @@ -14,9 +14,9 @@ * @{ * * @file - * @brief TCP interface definition + * @brief Gnrc TCP API * - * @author Simon Brummer + * @author Simon Brummer */ #ifndef GNRC_TCP_H diff --git a/sys/include/net/gnrc/tcp/config.h b/sys/include/net/gnrc/tcp/config.h index 1bc9ffe378..9470bfbbc8 100644 --- a/sys/include/net/gnrc/tcp/config.h +++ b/sys/include/net/gnrc/tcp/config.h @@ -1,5 +1,5 @@ /* - * Copyright (C) 2015 Simon Brummer + * Copyright (C) 2017 Simon Brummer * * 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 @@ -14,9 +14,9 @@ * @{ * * @file - * @brief TCP configuration, includes buffersizes, timeout durations + * @brief Gnrc tcp's configuration * - * @author Simon Brummer + * @author Simon Brummer */ #ifndef GNRC_TCP_CONFIG_H diff --git a/sys/include/net/gnrc/tcp/tcb.h b/sys/include/net/gnrc/tcp/tcb.h index f34814e939..113521ccf0 100644 --- a/sys/include/net/gnrc/tcp/tcb.h +++ b/sys/include/net/gnrc/tcp/tcb.h @@ -1,5 +1,5 @@ /* - * Copyright (C) 2015 Simon Brummer + * Copyright (C) 2017 Simon Brummer * * 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 @@ -14,9 +14,9 @@ * @{ * * @file - * @brief Transmission Control Block definition + * @brief Gnrc tcp's transmission control block * - * @author Simon Brummer + * @author Simon Brummer */ #ifndef GNRC_TCP_TCB_H diff --git a/sys/include/net/tcp.h b/sys/include/net/tcp.h index 64d7739cdd..2a6a9756af 100644 --- a/sys/include/net/tcp.h +++ b/sys/include/net/tcp.h @@ -14,9 +14,9 @@ * @{ * * @file - * @brief TCP header and helper functions + * @brief TCP header and helper functions * - * @author Simon Brummer + * @author Simon Brummer */ #ifndef TCP_H diff --git a/sys/net/gnrc/transport_layer/tcp/gnrc_tcp.c b/sys/net/gnrc/transport_layer/tcp/gnrc_tcp.c index ebbbd9544d..2de7d5595c 100644 --- a/sys/net/gnrc/transport_layer/tcp/gnrc_tcp.c +++ b/sys/net/gnrc/transport_layer/tcp/gnrc_tcp.c @@ -1,5 +1,5 @@ /* - * Copyright (C) 2015 Simon Brummer + * Copyright (C) 2017 Simon Brummer * * 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 @@ -11,9 +11,9 @@ * @{ * * @file - * @brief GNRC's TCP implementation + * @brief Gnrc tcp's API implementation * - * @author Simon Brummer + * @author Simon Brummer * @} */ diff --git a/sys/net/gnrc/transport_layer/tcp/gnrc_tcp_eventloop.c b/sys/net/gnrc/transport_layer/tcp/gnrc_tcp_eventloop.c index a1d929a8cd..803eeff932 100644 --- a/sys/net/gnrc/transport_layer/tcp/gnrc_tcp_eventloop.c +++ b/sys/net/gnrc/transport_layer/tcp/gnrc_tcp_eventloop.c @@ -1,5 +1,5 @@ /* - * Copyright (C) 2015 Simon Brummer + * Copyright (C) 2017 Simon Brummer * * 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 @@ -11,9 +11,9 @@ * @{ * * @file - * @brief GNRC's TCP event processing loop + * @brief Implementation of internal/eventloop.h * - * @author Simon Brummer + * @author Simon Brummer * @} */ diff --git a/sys/net/gnrc/transport_layer/tcp/gnrc_tcp_fsm.c b/sys/net/gnrc/transport_layer/tcp/gnrc_tcp_fsm.c index 2add62094b..8b5743b0d4 100644 --- a/sys/net/gnrc/transport_layer/tcp/gnrc_tcp_fsm.c +++ b/sys/net/gnrc/transport_layer/tcp/gnrc_tcp_fsm.c @@ -1,5 +1,5 @@ /* - * Copyright (C) 2015 Simon Brummer + * Copyright (C) 2017 Simon Brummer * * 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 @@ -11,9 +11,9 @@ * @{ * * @file - * @brief GNRC's TCP finite state maschine + * @brief Implementation of internal/fsm.h * - * @author Simon Brummer + * @author Simon Brummer * @} */ diff --git a/sys/net/gnrc/transport_layer/tcp/gnrc_tcp_option.c b/sys/net/gnrc/transport_layer/tcp/gnrc_tcp_option.c index 24e6a2c997..d1736d8c1e 100644 --- a/sys/net/gnrc/transport_layer/tcp/gnrc_tcp_option.c +++ b/sys/net/gnrc/transport_layer/tcp/gnrc_tcp_option.c @@ -1,5 +1,5 @@ /* - * Copyright (C) 2015 Simon Brummer + * Copyright (C) 2017 Simon Brummer * * 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 @@ -11,9 +11,9 @@ * @{ * * @file - * @brief GNRC's TCP option handling related functions + * @brief Implementation of internal/option.h * - * @author Simon Brummer + * @author Simon Brummer * @} */ #include "assert.h" diff --git a/sys/net/gnrc/transport_layer/tcp/gnrc_tcp_pkt.c b/sys/net/gnrc/transport_layer/tcp/gnrc_tcp_pkt.c index c3364ac0c5..3c5f452e08 100644 --- a/sys/net/gnrc/transport_layer/tcp/gnrc_tcp_pkt.c +++ b/sys/net/gnrc/transport_layer/tcp/gnrc_tcp_pkt.c @@ -1,5 +1,5 @@ /* - * Copyright (C) 2015 Simon Brummer + * Copyright (C) 2017 Simon Brummer * * 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 @@ -11,9 +11,9 @@ * @{ * * @file - * @brief GNRC's TCP paket related functions + * @brief Implementation of internal/pkt.h * - * @author Simon Brummer + * @author Simon Brummer * @} */ #include diff --git a/sys/net/gnrc/transport_layer/tcp/gnrc_tcp_rcvbuf.c b/sys/net/gnrc/transport_layer/tcp/gnrc_tcp_rcvbuf.c index cbe7231228..e546884657 100644 --- a/sys/net/gnrc/transport_layer/tcp/gnrc_tcp_rcvbuf.c +++ b/sys/net/gnrc/transport_layer/tcp/gnrc_tcp_rcvbuf.c @@ -1,5 +1,5 @@ /* - * Copyright (C) 2016 Simon Brummer + * Copyright (C) 2017 Simon Brummer * * 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 @@ -7,12 +7,13 @@ */ /** + * @ingroup net_gnrc * @{ * * @file - * @brief Implementation of tcp_internal/rcvbuf.h + * @brief Implementation of internal/rcvbuf.h * - * @author Brummer Simon + * @author Simon Brummer */ #include #include "internal/rcvbuf.h" diff --git a/sys/net/gnrc/transport_layer/tcp/internal/common.h b/sys/net/gnrc/transport_layer/tcp/internal/common.h index bdaac64f61..0f4354eddb 100644 --- a/sys/net/gnrc/transport_layer/tcp/internal/common.h +++ b/sys/net/gnrc/transport_layer/tcp/internal/common.h @@ -1,5 +1,5 @@ /* - * Copyright (C) 2015 Simon Brummer + * Copyright (C) 2017 Simon Brummer * * 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 @@ -14,9 +14,9 @@ * @{ * * @file - * @brief Helperfunctions and defines + * @brief Internally used common defines, macros and variable declaration * - * @author Simon Brummer + * @author Simon Brummer */ #ifndef GNRC_TCP_INTERNAL_COMMON_H diff --git a/sys/net/gnrc/transport_layer/tcp/internal/eventloop.h b/sys/net/gnrc/transport_layer/tcp/internal/eventloop.h index 702b3ed730..fb93f2e909 100644 --- a/sys/net/gnrc/transport_layer/tcp/internal/eventloop.h +++ b/sys/net/gnrc/transport_layer/tcp/internal/eventloop.h @@ -1,5 +1,5 @@ /* - * Copyright (C) 2015 Simon Brummer + * Copyright (C) 2017 Simon Brummer * * 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 @@ -14,9 +14,9 @@ * @{ * * @file - * @brief Definition for gnrc tcp event processing loop + * @brief Gnrc TCP's event processing loop delarations * - * @author Simon Brummer +* @author Simon Brummer */ #ifndef GNRC_TCP_INTERNAL_EVENTLOOP_H diff --git a/sys/net/gnrc/transport_layer/tcp/internal/fsm.h b/sys/net/gnrc/transport_layer/tcp/internal/fsm.h index 7efdc812da..89eaf5868d 100644 --- a/sys/net/gnrc/transport_layer/tcp/internal/fsm.h +++ b/sys/net/gnrc/transport_layer/tcp/internal/fsm.h @@ -1,5 +1,5 @@ /* - * Copyright (C) 2015 Simon Brummer + * Copyright (C) 2017 Simon Brummer * * 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 @@ -14,9 +14,9 @@ * @{ * * @file - * @brief Definies function to manipulate a connections state + * @brief Gnrc TCP's FSM declarations * - * @author Simon Brummer + * @author Simon Brummer */ #ifndef GNRC_TCP_INTERNAL_FSM_H diff --git a/sys/net/gnrc/transport_layer/tcp/internal/option.h b/sys/net/gnrc/transport_layer/tcp/internal/option.h index 775f50dead..ee2ffa1769 100644 --- a/sys/net/gnrc/transport_layer/tcp/internal/option.h +++ b/sys/net/gnrc/transport_layer/tcp/internal/option.h @@ -1,5 +1,5 @@ /* - * Copyright (C) 2015 Simon Brummer + * Copyright (C) 2017 Simon Brummer * * 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 @@ -14,9 +14,9 @@ * @{ * * @file - * @brief Defines and Macros for TCP option handling + * @brief TCP option handling function declaration * - * @author Simon Brummer + * @author Simon Brummer */ #ifndef GNRC_TCP_INTERNAL_OPTION_H diff --git a/sys/net/gnrc/transport_layer/tcp/internal/pkt.h b/sys/net/gnrc/transport_layer/tcp/internal/pkt.h index 0a1ea93e2f..aa833bd42c 100644 --- a/sys/net/gnrc/transport_layer/tcp/internal/pkt.h +++ b/sys/net/gnrc/transport_layer/tcp/internal/pkt.h @@ -1,5 +1,5 @@ /* - * Copyright (C) 2015 Simon Brummer + * Copyright (C) 2017 Simon Brummer * * 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 @@ -14,9 +14,9 @@ * @{ * * @file - * @brief Functions for TCP's paket handling + * @brief Gnrc tcb's paket handling declarations * - * @author Simon Brummer + * @author Simon Brummer */ #ifndef GNRC_TCP_INTERNAL_PKT_H diff --git a/sys/net/gnrc/transport_layer/tcp/internal/rcvbuf.h b/sys/net/gnrc/transport_layer/tcp/internal/rcvbuf.h index 2183061608..84ae7e2177 100644 --- a/sys/net/gnrc/transport_layer/tcp/internal/rcvbuf.h +++ b/sys/net/gnrc/transport_layer/tcp/internal/rcvbuf.h @@ -1,5 +1,5 @@ /* - * Copyright (C) 2015 Simon Brummer + * Copyright (C) 2017 Simon Brummer * * 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 @@ -14,9 +14,9 @@ * @{ * * @file - * @brief Functions for allocating and freeing the receive buffer + * @brief Functions for allocating and freeing the receive buffer * - * @author Simon Brummer + * @author Simon Brummer * @} */ #ifndef GNRC_TCP_INTERNAL_RCVBUF_H