From 9aa08fd3024a37ec739c01be13c693f3d6686614 Mon Sep 17 00:00:00 2001 From: George Oikonomou Date: Sat, 26 May 2018 02:04:22 +0100 Subject: [PATCH 1/2] Reposition the generic flash driver in the doxygen tree --- arch/dev/ext-flash/ext-flash.c | 4 ++-- arch/dev/ext-flash/ext-flash.h | 15 ++++++++++++--- 2 files changed, 14 insertions(+), 5 deletions(-) diff --git a/arch/dev/ext-flash/ext-flash.c b/arch/dev/ext-flash/ext-flash.c index 10e953ffa..c9378d2aa 100644 --- a/arch/dev/ext-flash/ext-flash.c +++ b/arch/dev/ext-flash/ext-flash.c @@ -29,11 +29,11 @@ */ /*---------------------------------------------------------------------------*/ /** - * \addtogroup sensortag-cc26xx-ext-flash + * \addtogroup ext-flash * @{ * * \file - * Sensortag/LaunchPad External Flash Driver + * Implementation of a generic external SPI flash driver */ /*---------------------------------------------------------------------------*/ #include "contiki.h" diff --git a/arch/dev/ext-flash/ext-flash.h b/arch/dev/ext-flash/ext-flash.h index 20748a2f0..73b7320f8 100644 --- a/arch/dev/ext-flash/ext-flash.h +++ b/arch/dev/ext-flash/ext-flash.h @@ -29,14 +29,23 @@ */ /*---------------------------------------------------------------------------*/ /** - * \addtogroup common-cc26xx-peripherals + * \addtogroup dev * @{ * - * \defgroup sensortag-cc26xx-ext-flash SensorTag/LaunchPad External Flash + * \defgroup ext-flash Generic external SPI flash driver + * + * This is a generic driver for external SPI flash memories. The driver has + * been tested and works with multiple external SPI flash parts. The list of + * parts the driver has been tested against is shown in the README in this + * directory. + * + * If you successfully use this driver with a part that is not listed in the + * README, please let us know so we can update it. + * * @{ * * \file - * Header file for the Sensortag/LaunchPad External Flash Driver + * Header file for the external SPI flash API */ /*---------------------------------------------------------------------------*/ #ifndef EXT_FLASH_H_ From 92e4ff3ef457ef1cc790324ada49b5e1a2cbc73b Mon Sep 17 00:00:00 2001 From: George Oikonomou Date: Sat, 26 May 2018 02:04:42 +0100 Subject: [PATCH 2/2] Tidy-up doxygen for uiplib --- os/net/ipv6/uiplib.c | 8 +++++++- os/net/ipv6/uiplib.h | 31 +++++++++++++++---------------- 2 files changed, 22 insertions(+), 17 deletions(-) diff --git a/os/net/ipv6/uiplib.c b/os/net/ipv6/uiplib.c index cd6d15c8b..a6d8b4f0c 100644 --- a/os/net/ipv6/uiplib.c +++ b/os/net/ipv6/uiplib.c @@ -33,8 +33,11 @@ */ /** + * \addtogroup uip-addr-lib + * @{ + * * \file - * Various uIP library functions. + * Implementation of the IP address manipulation library * \author * Nicolas Tsiftes * Niclas Finne @@ -223,3 +226,6 @@ uiplib_ipaddr_snprint(char *buf, size_t size, const uip_ipaddr_t *addr) return n; } /*---------------------------------------------------------------------------*/ +/** + * @} + */ diff --git a/os/net/ipv6/uiplib.h b/os/net/ipv6/uiplib.h index 3a935f51b..b30a1bcb5 100644 --- a/os/net/ipv6/uiplib.h +++ b/os/net/ipv6/uiplib.h @@ -31,23 +31,24 @@ * * */ - -/** - * \file - * Various uIP library functions. - * \author - * Adam Dunkels - * - */ - #ifndef UIPLIB_H_ #define UIPLIB_H_ #include "net/ipv6/uip.h" /** - * \addtogroup uipconvfunc + * \addtogroup uip * @{ + * + * \defgroup uip-addr-lib uIP address manipulation library + * + * A library with various IP address manipulation functions + * @{ + * + * \file + * Header file for the IP address manipulation library + * \author + * Adam Dunkels */ /** @@ -77,10 +78,6 @@ int uiplib_ip4addrconv(const char *addrstr, uip_ip4addr_t *addr); int uiplib_ip6addrconv(const char *addrstr, uip_ip6addr_t *addr); /** @} */ -/** - * \addtogroup uiplib - * @{ - */ /* The maxium length of an IPv6 string, including terminating null bytes * fd01:0002:0003:0004:0005:0006:0007:0008 => 39 + 1 bytes */ @@ -103,6 +100,8 @@ void uiplib_ipaddr_print(const uip_ipaddr_t *addr); */ int uiplib_ipaddr_snprint(char *buffer, size_t size, const uip_ipaddr_t *addr); -/** @} */ - #endif /* UIPLIB_H_ */ +/** + * @} + * @} + */