RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity

drivers/can: fix doxygen documentation + typo

Browse Source
This commit is contained in:
Alexandre Abadie 2017-07-02 18:33:45 +02:00
parent f6f9ba157d
commit 268c6b647e
25 changed files with 70 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
cpu/native/can/candev_linux.c
View File

@ -7,7 +7,7 @@
*/
/**
* @ingroup native_cpu
* @ingroup drivers_candev_linux
* @{
*
* @file

6
cpu/native/include/candev_linux.h
View File

@ -7,9 +7,9 @@
*/
/**
* @ingroup native_cpu
* @defgroup drivers_candev_linux SocketCAN driver
* @ingroup drivers_can
* @defgroup candev_linux SocketCAN driver
* @brief Implementation of simulated CAN controller driver using SocketCAN on Linux
* @{
*
* @file
@ -18,7 +18,6 @@
* @author Hermann Lelong <hermann@otakeys.com>
* @author Aurelien Gonce <aurelien.gonce@altran.com>
* @author Vincent Dupont <vincent@otakeys.com>
* @}
*/
#ifndef CANDEV_LINUX_H
@ -102,3 +101,4 @@ extern candev_linux_conf_t candev_linux_conf[CAN_DLL_NUMOF];
#endif
#endif /* CANDEV_LINUX_H */
/** @} */

3
cpu/native/include/candev_linux_params.h
View File

@ -7,14 +7,13 @@
*/
/**
* @ingroup candev_linux
* @ingroup drivers_candev_linux
* @{
*
* @file
* @brief Default linux can config
*
* @author Vincent Dupont <vincent@otakeys.com>
* @}
*/
#ifndef CANDEV_LINUX_PARAMS_H

5
drivers/can_trx/can_trx.c
View File

@ -7,16 +7,15 @@
*/
/**
* @defgroup drivers_can transceiver
* @ingroup drivers
* @ingroup drivers_can_trx
* @brief generic transceiver interface
*
* @{
*
* @file
* @brief generic transceiver interface
*
* @author Vincent Dupont <vincent@otakeys.com>
* @}
*/
#include <errno.h>

10
drivers/include/can/can_trx.h
View File

@ -7,15 +7,13 @@
*/
/**
* @defgroup trx_can CAN transceiver
* @ingroup can
* @ingroup drivers
* @brief generic transceiver interface
*
* @defgroup drivers_can_trx CAN transceiver interface
* @ingroup drivers_can
* @brief CAN generic transceiver interface
* @{
*
* @file
* @brief generic transceiver interface
* @brief CAN generic transceiver interface
*
* @author Aurelien Gonce <aurelien.gonce@altran.com>
* @author Vincent Dupont <vincent@otakeys.com>

14
drivers/include/can/candev.h
View File

@ -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 <vincent@otakeys.com>
* @author Toon Stegen <toon.stegen@altran.com>
@ -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 */

9
drivers/include/can/doc.txt Normal file
View File

@ -0,0 +1,9 @@
/**
* @defgroup drivers_can CAN Drivers
* @ingroup drivers_netdev
* @brief Drivers for CAN devices
* @see sys_can
*
* @note These devices are not covered by the @ref drivers_netdev API
* but by the @ref drivers_candev API.
*/

3
sys/can/conn/isotp.c
View File

@ -7,10 +7,13 @@
*/
/**
* @ingroup sys_can_conn
* @{
* @file
* @brief Implementation of isotp CAN connection
*
* @author Vincent Dupont <vincent@otakeys.com>
* @}
*/
#ifdef MODULE_CAN_ISOTP

3
sys/can/conn/raw.c
View File

@ -7,10 +7,13 @@
*/
/**
* @ingroup sys_can_conn
* @{
* @file
* @brief Implementation of raw CAN connection
*
* @author Vincent Dupont <vincent@otakeys.com>
* @}
*/
#include <errno.h>

3
sys/can/device.c
View File

@ -7,12 +7,15 @@
*/
/**
* @ingroup sys_can_dll
* @{
* @file
* @brief CAN device interface
*
* @author Toon Stegen <toon.stegen@altran.com>
* @author Vincent Dupont <vincent@otakeys.com>
* @author Aurelien Gonce <aurelien.gonce@altran.com>
* @}
*/
#include <errno.h>

3
sys/can/dll.c
View File

@ -7,6 +7,8 @@
*/
/**
* @ingroup sys_can_dll
* @{
* @file
* @brief CAN Data Link Layer module
*
@ -18,6 +20,7 @@
* @author Toon Stegen <toon.stegen@altran.com>
* @author Vincent Dupont <vincent@otakeys.com>
* @author Aurelien Gonce <aurelien.gonce@altran.com>
* @}
*/
#include <errno.h>

3
sys/can/isotp/isotp.c
View File

@ -7,10 +7,13 @@
*/
/**
* @ingroup sys_can_isotp
* @{
* @file
* @brief ISO TP high level interface
*
* @author Vincent Dupont <vincent@otakeys.com>
* @}
*/
#include <errno.h>

3
sys/can/pkt.c
View File

@ -7,11 +7,14 @@
*/
/**
* @ingroup sys_can_dll
* @{
* @file
* @brief CAN memory allocation module
*
* @author Vincent Dupont <vincent@otakeys.com>
* @author Toon Stegen <toon.stegen@altran.com>
* @}
*/
#include <string.h>

4
sys/can/router.c
View File

@ -7,12 +7,14 @@
*/
/**
*
* @ingroup sys_can_dll
* @{
* @file
* @brief Functions for routing RX can frames
*
* @author Toon Stegen <toon.stegen@altran.com>
* @author Vincent Dupont <vincent@otakeys.com>
* @}
*/
#include <stdint.h>

9
sys/include/can/can.h
View File

@ -7,16 +7,15 @@
*/
/**
* @ingroup can
* @defgroup can_dll Data Link Layer
* @defgroup sys_can_dll Data Link Layer
* @ingroup sys_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.
*
* It can be used to send and receive raw CAN frames through multiple CAN
* controllers.
* @{
*
*
* @file
* @brief Definitions high-level CAN interface
*

4
sys/include/can/common.h
View File

@ -7,8 +7,8 @@
*/
/**
* @ingroup can
* @defgroup can_common Common
* @defgroup sys_can_common Common definitions
* @ingroup sys_can
* @brief CAN stack common definitions
*
* This module defines the common part of the CAN stack, including structures

3
sys/include/can/conn/isotp.h
View File

@ -7,10 +7,9 @@
*/
/**
* @ingroup conn_can
* @ingroup sys_can_conn
* @{
*
*
* @file
* @brief Definitions of generic CAN interface
*

5
sys/include/can/conn/raw.h
View File

@ -7,15 +7,14 @@
*/
/**
* @ingroup can
* @defgroup conn_can Connection
* @defgroup sys_can_conn Connection
* @ingroup sys_can
* @brief conn interface for CAN stack
*
* This is the user interface to send and receive raw CAN frames or ISO-TP datagrams
*
* @{
*
*
* @file
* @brief Definitions of generic CAN interface
*

3
sys/include/can/device.h
View File

@ -7,10 +7,9 @@
*/
/**
* @ingroup can_dll
* @ingroup sys_can_dll
* @{
*
*
* @file
* @brief Definitions of CAN device interface
*

3
sys/include/can/dll.h
View File

@ -7,10 +7,9 @@
*/
/**
* @ingroup can_dll
* @ingroup sys_can_dll
* @{
*
*
* @file
* @brief Definitions of low-level CAN DLL interface
*

5
sys/include/can/doc.txt
View File

@ -1,5 +1,6 @@
/**
* @defgroup can CAN
* @defgroup sys_can CAN (Controller Area Network)
* @ingroup net
* @brief RIOT CAN stack
*
* This module is a full CAN stack integrated to RIOT.
@ -20,4 +21,6 @@
*
* Finally, the connection layer is the user interface to send and receive raw
* CAN frames or ISO-TP datagrams.
*
* @see drivers_can
*/

5
sys/include/can/isotp.h
View File

@ -7,12 +7,11 @@
*/
/**
* @ingroup can
* @defgroup isotp ISOTP
* @defgroup sys_can_isotp ISO transport protocol over CAN
* @ingroup sys_can
* @brief ISO transport protocol over CAN (ISO15765)
* @{
*
*
* @file
* @brief ISO TP high level interface
*

4
sys/include/can/pkt.h
View File

@ -7,10 +7,9 @@
*/
/**
* @ingroup can_dll
* @ingroup sys_can_dll
* @{
*
*
* @file
* @brief CAN memory allocation module
*
@ -148,5 +147,4 @@ void can_pkt_buf_free(void *data, size_t size);
#endif
#endif /* CAN_PKT_H */
/** @} */

6
sys/include/can/raw.h
View File

@ -7,14 +7,14 @@
*/
/**
* @ingroup can_dll
* @ingroup sys_can_dll
* @{
*
*
* @file
* @brief Definitions high-level RAW CAN interface
*
* This file defines the hig-level CAN interface to send and receive RAW CAN frame.
* This file defines the high-level CAN interface to send and receive RAW CAN
* frame.
*
* @author Vincent Dupont <vincent@otakeys.com>
* @author Toon Stegen <toon.stegen@altran.com>

4
sys/include/can/router.h
View File

@ -7,10 +7,9 @@
*/
/**
* @ingroup can_dll
* @ingroup sys_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 */
/** @} */