fixup! drivers/can: fix doxygen documentation + typo

RIOT-OS · Jul 2, 2017 · af6a5c5 · af6a5c5
1 parent 127592e
commit af6a5c5
Show file tree

Hide file tree

Showing 23 changed files with 40 additions and 37 deletions.
diff --git a/cpu/native/can/candev_linux.c b/cpu/native/can/candev_linux.c
@@ -7,7 +7,7 @@
  */
 
 /**
- * @ingroup     candev_linux
+ * @ingroup     drivers_candev_linux
  * @{
  *
  * @file

diff --git a/cpu/native/include/candev_linux.h b/cpu/native/include/candev_linux.h
@@ -7,7 +7,7 @@
  */
 
 /**
- * @defgroup    candev_linux SocketCAN driver
+ * @defgroup    drivers_candev_linux SocketCAN driver
  * @ingroup     drivers_can
  * @brief       Implementation of simulated CAN controller driver using SocketCAN on Linux
  * @{

diff --git a/cpu/native/include/candev_linux_params.h b/cpu/native/include/candev_linux_params.h
@@ -7,7 +7,7 @@
  */
 
 /**
- * @ingroup     candev_linux
+ * @ingroup     drivers_candev_linux
  * @{
  *
  * @file

diff --git a/drivers/doc.txt b/drivers/doc.txt
@@ -43,10 +43,3 @@
  * @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/doc.txt b/drivers/include/can/doc.txt
@@ -0,0 +1,6 @@
+/**
+ * @defgroup    drivers_can CAN Drivers
+ * @ingroup     drivers_netdev
+ * @brief       Drivers for CAN devices
+ * @see         sys_can
+ */
diff --git a/sys/can/conn/isotp.c b/sys/can/conn/isotp.c
@@ -7,7 +7,7 @@
  */
 
 /**
- * @ingroup     conn_can
+ * @ingroup     sys_conn_can
  * @{
  * @file
  * @brief       Implementation of isotp CAN connection

diff --git a/sys/can/conn/raw.c b/sys/can/conn/raw.c
@@ -7,7 +7,7 @@
  */
 
 /**
- * @ingroup     conn_can
+ * @ingroup     sys_conn_can
  * @{
  * @file
  * @brief       Implementation of raw CAN connection

diff --git a/sys/can/device.c b/sys/can/device.c
@@ -7,7 +7,7 @@
  */
 
 /**
- * @ingroup     can_dll
+ * @ingroup     sys_can_dll
  * @{
  * @file
  * @brief       CAN device interface

diff --git a/sys/can/dll.c b/sys/can/dll.c
@@ -7,6 +7,8 @@
  */
 
 /**
+ * @ingroup     sys_can_dll
+ * @{
  * @file
  * @brief       CAN Data Link Layer module
  *
@@ -18,6 +20,7 @@
  * @author      Toon Stegen <[email protected]>
  * @author      Vincent Dupont <[email protected]>
  * @author      Aurelien Gonce <[email protected]>
+ * @}
  */
 
 #include <errno.h>

diff --git a/sys/can/isotp/isotp.c b/sys/can/isotp/isotp.c
@@ -7,7 +7,7 @@
  */
 
 /**
- * @ingroup     can_isotp
+ * @ingroup     sys_can_isotp
  * @{
  * @file
  * @brief       ISO TP high level interface

diff --git a/sys/can/pkt.c b/sys/can/pkt.c
@@ -7,7 +7,7 @@
  */
 
 /**
- * @ingroup     can_dll
+ * @ingroup     sys_can_dll
  * @{
  * @file
  * @brief       CAN memory allocation module

diff --git a/sys/can/router.c b/sys/can/router.c
@@ -7,7 +7,7 @@
  */
 
 /**
- * @ingroup     can_dll
+ * @ingroup     sys_can_dll
  * @{
  * @file
  * @brief       Functions for routing RX can frames

diff --git a/sys/include/can/can.h b/sys/include/can/can.h
@@ -7,12 +7,13 @@
  */
 
 /**
- * @defgroup    can_dll Data Link Layer
- * @ingroup     can
+ * @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

diff --git a/sys/include/can/common.h b/sys/include/can/common.h
@@ -7,8 +7,8 @@
  */
 
 /**
- * @defgroup   can_common  Common
- * @ingroup    can
+ * @defgroup   sys_can_common  Common
+ * @ingroup    sys_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/isotp.h b/sys/include/can/conn/isotp.h
@@ -7,10 +7,9 @@
  */
 
 /**
- * @ingroup    conn_can
+ * @ingroup    sys_conn_can
  * @{
  *
- *
  * @file
  * @brief       Definitions of generic CAN interface
  *

diff --git a/sys/include/can/conn/raw.h b/sys/include/can/conn/raw.h
@@ -7,15 +7,14 @@
  */
 
 /**
- * @defgroup    conn_can Connection
- * @ingroup     can
+ * @defgroup    sys_conn_can 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
  *

diff --git a/sys/include/can/device.h b/sys/include/can/device.h
@@ -7,10 +7,9 @@
  */
 
 /**
- * @ingroup    can_dll
+ * @ingroup    sys_can_dll
  * @{
  *
- *
  * @file
  * @brief       Definitions of CAN device interface
  *

diff --git a/sys/include/can/dll.h b/sys/include/can/dll.h
@@ -7,7 +7,7 @@
  */
 
 /**
- * @ingroup    can_dll
+ * @ingroup    sys_can_dll
  * @{
  *
  * @file

diff --git a/sys/include/can/doc.txt b/sys/include/can/doc.txt
@@ -1,5 +1,6 @@
 /**
- * @defgroup can CAN (Controller Area Network)
+ * @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
  */
diff --git a/sys/include/can/isotp.h b/sys/include/can/isotp.h
@@ -7,8 +7,8 @@
  */
 
 /**
- * @defgroup    can_isotp ISOTP
- * @ingroup     can
+ * @defgroup    sys_can_isotp ISOTP
+ * @ingroup     sys_can
  * @brief       ISO transport protocol over CAN (ISO15765)
  * @{
  *

diff --git a/sys/include/can/pkt.h b/sys/include/can/pkt.h
@@ -7,10 +7,9 @@
  */
 
 /**
- * @ingroup    can_dll
+ * @ingroup    sys_can_dll
  * @{
  *
- *
  * @file
  * @brief       CAN memory allocation module
  *

diff --git a/sys/include/can/raw.h b/sys/include/can/raw.h
@@ -7,13 +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 <[email protected]>
  * @author      Toon Stegen <[email protected]>

diff --git a/sys/include/can/router.h b/sys/include/can/router.h
@@ -7,7 +7,7 @@
  */
 
 /**
- * @ingroup    can_dll
+ * @ingroup    sys_can_dll
  * @{
  *
  * @file
-Original file line number
+Diff line change
@@ Expand Up / @@ -7,7 +7,7 @@ @@
      */
     /**
-     * @ingroup     candev_linux
+     * @ingroup     drivers_candev_linux
      * @{
      *
      * @file
@@ Expand Down @@