From 0d8511616a3ac3ebd07ffe36107e3d340cff798d Mon Sep 17 00:00:00 2001 From: "Martine S. Lenders" Date: Wed, 9 Oct 2019 11:26:55 +0200 Subject: [PATCH 1/2] emb6: fix documentation --- doc/doxygen/riot.doxyfile | 1 - pkg/emb6/include/board_conf.h | 3 +-- pkg/emb6/include/sock_types.h | 3 +++ 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/doc/doxygen/riot.doxyfile b/doc/doxygen/riot.doxyfile index d81a0c94f5..eed7cfbf81 100644 --- a/doc/doxygen/riot.doxyfile +++ b/doc/doxygen/riot.doxyfile @@ -828,7 +828,6 @@ EXCLUDE_PATTERNS = */board/*/tools/* \ */cpu/native/osx-libc-extra \ */cpu/x86/include/* \ */drivers/kw2xrf/include/overwrites.h \ - */pkg/emb6/* \ */pkg/lwip/* \ */pkg/tlsf/patch.txt \ */sys/include/embUnit/* \ diff --git a/pkg/emb6/include/board_conf.h b/pkg/emb6/include/board_conf.h index 884c1a66ed..5480583e5b 100644 --- a/pkg/emb6/include/board_conf.h +++ b/pkg/emb6/include/board_conf.h @@ -7,8 +7,7 @@ */ /** - * @defgroup emb6 emb6 network stack - * @ingroup pkg + * @addtogroup pkg_emb6 * @brief * @{ * diff --git a/pkg/emb6/include/sock_types.h b/pkg/emb6/include/sock_types.h index f81f70b4da..9240e78329 100644 --- a/pkg/emb6/include/sock_types.h +++ b/pkg/emb6/include/sock_types.h @@ -33,6 +33,9 @@ extern "C" { #endif +/** + * @brief Size for struct sock_udp::mbox_queue + */ #ifndef SOCK_MBOX_SIZE #define SOCK_MBOX_SIZE (2) #endif From 7cf1bab2e6d049dbdf63a67de58fd5f23b380922 Mon Sep 17 00:00:00 2001 From: Martine Lenders Date: Tue, 8 Oct 2019 10:21:10 +0200 Subject: [PATCH 2/2] emb6: deprecate package I basically didn't work on `emb6` since 2016 and adapting to the newest version would mean some major overhaul. However, the development at their end seems to be stalled [since March 2018][emb6-develop] as well. All this speaks for deprecating this package. [emb6-develop]: https://github.com/hso-esk/emb6/tree/develop --- pkg/emb6/doc.txt | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/pkg/emb6/doc.txt b/pkg/emb6/doc.txt index cbf7ecef48..644009a801 100644 --- a/pkg/emb6/doc.txt +++ b/pkg/emb6/doc.txt @@ -5,6 +5,10 @@ * @brief emb6 network stack * @see https://github.com/hso-esk/emb6/blob/14e4a3cfff01644e078870e14e16a1fe60dcc895/doc/pdf/emb6.pdf * + * @deprecated Based on very old version of `emb6` and the package is + * basically unmaintained; will be removed after the 2020.07 + * release. + * * emb6 is a fork of Contiki's uIP network stack without its usage of * proto-threads. It uses periodic event polling instead. */