diff --git a/cpu/native/can/candev_linux.c b/cpu/native/can/candev_linux.c index a481c63a0e6f5..053fce4a77b24 100644 --- a/cpu/native/can/candev_linux.c +++ b/cpu/native/can/candev_linux.c @@ -7,7 +7,7 @@ */ /** - * @ingroup native_cpu + * @ingroup candev_linux * @{ * * @file diff --git a/cpu/native/include/candev_linux.h b/cpu/native/include/candev_linux.h index 54f451b7e9d0f..c8a1f83c525c2 100644 --- a/cpu/native/include/candev_linux.h +++ b/cpu/native/include/candev_linux.h @@ -7,9 +7,9 @@ */ /** - * @ingroup native_cpu - * @ingroup drivers_can * @defgroup candev_linux SocketCAN driver + * @ingroup drivers_can + * @brief Implementation of simulated CAN controller driver using SocketCAN on Linux * @{ * * @file @@ -18,7 +18,6 @@ * @author Hermann Lelong * @author Aurelien Gonce * @author Vincent Dupont - * @} */ #ifndef CANDEV_LINUX_H @@ -102,3 +101,4 @@ extern candev_linux_conf_t candev_linux_conf[CAN_DLL_NUMOF]; #endif #endif /* CANDEV_LINUX_H */ +/** @} */ diff --git a/cpu/native/include/candev_linux_params.h b/cpu/native/include/candev_linux_params.h index 68ce965c1833e..ecf5320bc1b61 100644 --- a/cpu/native/include/candev_linux_params.h +++ b/cpu/native/include/candev_linux_params.h @@ -14,7 +14,6 @@ * @brief Default linux can config * * @author Vincent Dupont - * @} */ #ifndef CANDEV_LINUX_PARAMS_H diff --git a/drivers/can_trx/can_trx.c b/drivers/can_trx/can_trx.c index 0f6057fc84542..470eebee4d4a9 100644 --- a/drivers/can_trx/can_trx.c +++ b/drivers/can_trx/can_trx.c @@ -7,16 +7,15 @@ */ /** - * @defgroup drivers_can transceiver - * @ingroup drivers + * @ingroup drivers_trx_can * @brief generic transceiver interface - * * @{ * * @file * @brief generic transceiver interface * * @author Vincent Dupont + * @} */ #include diff --git a/drivers/doc.txt b/drivers/doc.txt index 23e16eb169ee3..e16c3f7e66be2 100644 --- a/drivers/doc.txt +++ b/drivers/doc.txt @@ -43,3 +43,10 @@ * @ingroup drivers * @brief Drivers for storage devices */ + +/** + * @defgroup drivers_can CAN Drivers + * @ingroup drivers + * @ingroup can + * @brief Drivers for CAN devices + */ diff --git a/drivers/include/can/can_trx.h b/drivers/include/can/can_trx.h index 432b81ca0910d..3e6c56a5d4dde 100644 --- a/drivers/include/can/can_trx.h +++ b/drivers/include/can/can_trx.h @@ -7,15 +7,13 @@ */ /** - * @defgroup trx_can CAN transceiver - * @ingroup can - * @ingroup drivers - * @brief generic transceiver interface - * + * @defgroup drivers_trx_can CAN transceiver interface + * @ingroup drivers_can + * @brief CAN generic transceiver interface * @{ * * @file - * @brief generic transceiver interface + * @brief CAN generic transceiver interface * * @author Aurelien Gonce * @author Vincent Dupont diff --git a/drivers/include/can/candev.h b/drivers/include/can/candev.h index 5b6b66775ca8b..ca0cea5298b2c 100644 --- a/drivers/include/can/candev.h +++ b/drivers/include/can/candev.h @@ -7,15 +7,15 @@ */ /** - * @ingroup can - * @ingroup drivers - * @defgroup drivers_can CAN drivers + * @defgroup drivers_candev CAN device driver interface + * @ingroup drivers_can + * @brief Definitions for low-level CAN driver interface * @{ * - * This is the CAN controller driver interface + * This is the CAN controller generic driver interface * * @file - * @brief Definitions low-level CAN driver interface + * @brief Definitions for low-level CAN driver interface * * @author Vincent Dupont * @author Toon Stegen @@ -37,12 +37,12 @@ extern "C" { /** - * @brief Possible event types that are send from the device driver to the + * @brief Possible event types that are sent from the device driver to the * upper layer */ typedef enum { CANDEV_EVENT_NOEVENT, /**< no event, used internally */ - CANDEV_EVENT_ISR, /**< driver needs it's ISR handled */ + CANDEV_EVENT_ISR, /**< driver needs its ISR handled */ CANDEV_EVENT_WAKE_UP, /**< driver has been woken up by bus */ CANDEV_EVENT_TX_CONFIRMATION, /**< a packet has been sent */ CANDEV_EVENT_TIMEOUT_TX_CONF, /**< tx conf timeout received */ diff --git a/sys/can/conn/isotp.c b/sys/can/conn/isotp.c index 16b7328275443..0a2dc1a7a4efb 100644 --- a/sys/can/conn/isotp.c +++ b/sys/can/conn/isotp.c @@ -7,10 +7,13 @@ */ /** + * @ingroup conn_can + * @{ * @file * @brief Implementation of isotp CAN connection * * @author Vincent Dupont + * @} */ #ifdef MODULE_CAN_ISOTP diff --git a/sys/can/conn/raw.c b/sys/can/conn/raw.c index 6d3678ddcaa39..effdbd41c037a 100644 --- a/sys/can/conn/raw.c +++ b/sys/can/conn/raw.c @@ -7,10 +7,13 @@ */ /** + * @ingroup conn_can + * @{ * @file * @brief Implementation of raw CAN connection * * @author Vincent Dupont + * @} */ #include diff --git a/sys/can/device.c b/sys/can/device.c index ab159aaab748a..241dcdf0c35c7 100644 --- a/sys/can/device.c +++ b/sys/can/device.c @@ -7,12 +7,15 @@ */ /** + * @ingroup can_dll + * @{ * @file * @brief CAN device interface * * @author Toon Stegen * @author Vincent Dupont * @author Aurelien Gonce + * @} */ #include diff --git a/sys/can/isotp/isotp.c b/sys/can/isotp/isotp.c index 8ee8c72b2d17e..f0b8049148e4f 100644 --- a/sys/can/isotp/isotp.c +++ b/sys/can/isotp/isotp.c @@ -7,10 +7,13 @@ */ /** + * @ingroup can_isotp + * @{ * @file * @brief ISO TP high level interface * * @author Vincent Dupont + * @} */ #include diff --git a/sys/can/pkt.c b/sys/can/pkt.c index cf032e81c10d1..a8573d1c2fb9b 100644 --- a/sys/can/pkt.c +++ b/sys/can/pkt.c @@ -7,11 +7,14 @@ */ /** + * @ingroup can_dll + * @{ * @file * @brief CAN memory allocation module * * @author Vincent Dupont * @author Toon Stegen + * @} */ #include diff --git a/sys/can/router.c b/sys/can/router.c index 2471c33b37d99..0a799e1ce8bfd 100644 --- a/sys/can/router.c +++ b/sys/can/router.c @@ -7,12 +7,14 @@ */ /** - * + * @ingroup can_dll + * @{ * @file * @brief Functions for routing RX can frames * * @author Toon Stegen * @author Vincent Dupont + * @} */ #include diff --git a/sys/include/can/can.h b/sys/include/can/can.h index 477aec7ed4cb4..e4b2af1b2bf79 100644 --- a/sys/include/can/can.h +++ b/sys/include/can/can.h @@ -7,16 +7,14 @@ */ /** - * @ingroup can * @defgroup can_dll Data Link Layer + * @ingroup can * @brief CAN Data Link Layer * * The Data Link Layer is composed of the device, router, pkt and dll files. * It can be used to send and receive raw CAN frames through multiple CAN controllers. - * * @{ * - * * @file * @brief Definitions high-level CAN interface * diff --git a/sys/include/can/common.h b/sys/include/can/common.h index 38040fadc10cf..ceae62232d037 100644 --- a/sys/include/can/common.h +++ b/sys/include/can/common.h @@ -7,8 +7,8 @@ */ /** - * @ingroup can * @defgroup can_common Common + * @ingroup can * @brief CAN stack common definitions * * This module defines the common part of the CAN stack, including structures diff --git a/sys/include/can/conn/raw.h b/sys/include/can/conn/raw.h index fee1fbc0662f6..5d8be590e392a 100644 --- a/sys/include/can/conn/raw.h +++ b/sys/include/can/conn/raw.h @@ -7,8 +7,8 @@ */ /** - * @ingroup can * @defgroup conn_can Connection + * @ingroup can * @brief conn interface for CAN stack * * This is the user interface to send and receive raw CAN frames or ISO-TP datagrams diff --git a/sys/include/can/dll.h b/sys/include/can/dll.h index 503e97fb980b5..7b43228375e13 100644 --- a/sys/include/can/dll.h +++ b/sys/include/can/dll.h @@ -10,7 +10,6 @@ * @ingroup can_dll * @{ * - * * @file * @brief Definitions of low-level CAN DLL interface * diff --git a/sys/include/can/doc.txt b/sys/include/can/doc.txt index 6b17fecc42889..de4aecfda7d60 100644 --- a/sys/include/can/doc.txt +++ b/sys/include/can/doc.txt @@ -1,5 +1,5 @@ /** - * @defgroup can CAN + * @defgroup can CAN (Controller Area Network) * @brief RIOT CAN stack * * This module is a full CAN stack integrated to RIOT. diff --git a/sys/include/can/isotp.h b/sys/include/can/isotp.h index 2fe456385ea7a..ee2261f2ed80a 100644 --- a/sys/include/can/isotp.h +++ b/sys/include/can/isotp.h @@ -7,12 +7,11 @@ */ /** + * @defgroup can_isotp ISOTP * @ingroup can - * @defgroup isotp ISOTP * @brief ISO transport protocol over CAN (ISO15765) * @{ * - * * @file * @brief ISO TP high level interface * diff --git a/sys/include/can/pkt.h b/sys/include/can/pkt.h index 9744254dda398..5df9d1f43ab80 100644 --- a/sys/include/can/pkt.h +++ b/sys/include/can/pkt.h @@ -148,5 +148,4 @@ void can_pkt_buf_free(void *data, size_t size); #endif #endif /* CAN_PKT_H */ - /** @} */ diff --git a/sys/include/can/raw.h b/sys/include/can/raw.h index 4420be9d40acf..e126ea71e7050 100644 --- a/sys/include/can/raw.h +++ b/sys/include/can/raw.h @@ -10,7 +10,6 @@ * @ingroup can_dll * @{ * - * * @file * @brief Definitions high-level RAW CAN interface * diff --git a/sys/include/can/router.h b/sys/include/can/router.h index d5679a1df8466..eb9382bd645ce 100644 --- a/sys/include/can/router.h +++ b/sys/include/can/router.h @@ -10,7 +10,6 @@ * @ingroup can_dll * @{ * - * * @file * @brief Functions for routing RX can frames * @@ -112,5 +111,4 @@ int can_router_dispatch_tx_error(can_pkt_t *pkt); #endif #endif /* CAN_ROUTER_H */ - /** @} */