Changeset 4122410 in mainline for uspace/drv/platform

Timestamp:

2018-08-29T21:26:21Z (7 years ago)

Author:

Jakub Jermar <jakub@…>

Branches:

lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

c8ea6eca

Parents:

46f7b64

Message:

Improve Doxygen documentaion

This is stil WiP. A number of libraries, drivers and services were
converted to using a more hierarchical and decentralized scheme when it
comes to specifying to which doxygen group they belong.

Location:

uspace/drv/platform

Files:

• amdm37x/amdm37x.c (modified) (2 diffs)
• amdm37x/amdm37x.h (modified) (1 diff)
• amdm37x/cm/clock_control.h (modified) (1 diff)
• amdm37x/cm/core.h (modified) (1 diff)
• amdm37x/cm/iva2.h (modified) (1 diff)
• amdm37x/cm/mpu.h (modified) (1 diff)
• amdm37x/cm/usbhost.h (modified) (1 diff)
• amdm37x/doc/doxygroups.h (added)
• amdm37x/main.c (modified) (1 diff)
• amdm37x/prm/clock_control.h (modified) (1 diff)
• amdm37x/prm/global_reg.h (modified) (1 diff)
• amdm37x/prm/usbhost.h (modified) (1 diff)
• amdm37x/uhh.h (modified) (1 diff)
• amdm37x/usbtll.h (modified) (1 diff)
• icp/doc/doxygroups.h (added)
• icp/icp.c (modified) (1 diff)
• mac/doc/doxygroups.h (added)
• mac/mac.c (modified) (1 diff)
• malta/doc/doxygroups.h (added)
• malta/malta.c (modified) (1 diff)
• msim/doc/doxygroups.h (added)
• msim/msim.c (modified) (1 diff)
• pc/doc/doxygroups.h (added)
• pc/pc.c (modified) (1 diff)
• ski/doc/doxygroups.h (added)
• ski/ski.c (modified) (1 diff)
• sun4u/doc/doxygroups.h (added)
• sun4u/sun4u.c (modified) (1 diff)
• sun4v/doc/doxygroups.h (added)
• sun4v/sun4v.c (modified) (1 diff)

uspace/drv/platform/amdm37x/amdm37x.c

@@ -28 +28 @@
 
 /**
- * @defgroup amdm37x TI AM/DM37x platform driver.
- * @brief HelenOS TI AM/DM37x platform driver.
+ * @addtogroup amdm37x
  * @{
  */
@@ -424 +423 @@
         return EOK;
 }
+
+/**
+ * @}
+ */

uspace/drv/platform/amdm37x/amdm37x.h

@@ -27 +27 @@
  */
 
-/** @addtogroup amdm37xdrv
+/** @addtogroup amdm37x
  * @{
  */

uspace/drv/platform/amdm37x/cm/clock_control.h

@@ -27 +27 @@
  */
 
-/** @addtogroup amdm37xdrvclockcontrolcm
+/** @addtogroup amdm37x
  * @{
  */

uspace/drv/platform/amdm37x/cm/core.h

@@ -27 +27 @@
  */
 
-/** @addtogroup amdm37xdrvcorecm
+/** @addtogroup amdm37x
  * @{
  */

uspace/drv/platform/amdm37x/cm/iva2.h

@@ -27 +27 @@
  */
 
-/** @addtogroup amdm37xdrvcm
+/** @addtogroup amdm37x
  * @{
  */

uspace/drv/platform/amdm37x/cm/mpu.h

@@ -27 +27 @@
  */
 
-/** @addtogroup amdm37xdrvcm
+/** @addtogroup amdm37x
  * @{
  */

uspace/drv/platform/amdm37x/cm/usbhost.h

@@ -27 +27 @@
  */
 
-/** @addtogroup amdm37xdrvusbhostcm
+/** @addtogroup amdm37x
  * @{
  */

uspace/drv/platform/amdm37x/main.c

@@ -28 +28 @@
 
 /**
- * @defgroup amdm37x TI AM/DM37x platform driver.
- * @brief HelenOS TI AM/DM37x platform driver.
+ * @addtogroup amdm37x
  * @{
  */

uspace/drv/platform/amdm37x/prm/clock_control.h

@@ -27 +27 @@
  */
 
-/** @addtogroup amdm37xdrvprm
+/** @addtogroup amdm37x
  * @{
  */

uspace/drv/platform/amdm37x/prm/global_reg.h

@@ -27 +27 @@
  */
 
-/** @addtogroup amdm37xdrvprm
+/** @addtogroup amdm37x
  * @{
  */

uspace/drv/platform/amdm37x/prm/usbhost.h

@@ -27 +27 @@
  */
 
-/** @addtogroup amdm37xdrvprm
+/** @addtogroup amdm37x
  * @{
  */

uspace/drv/platform/amdm37x/uhh.h

@@ -27 +27 @@
  */
 
-/** @addtogroup amdm37xdrvuhh
+/** @addtogroup amdm37x
  * @{
  */

uspace/drv/platform/amdm37x/usbtll.h

@@ -27 +27 @@
  */
 
-/** @addtogroup amdm37xdrvusbtll
+/** @addtogroup amdm37x
  * @{
  */

uspace/drv/platform/icp/icp.c

@@ -28 +28 @@
 
 /**
- * @defgroup icp IntegratorCP platform driver.
- * @brief HelenOS IntegratorCP platform driver.
+ * @addtogroup icp
  * @{
  */

uspace/drv/platform/mac/mac.c

@@ -29 +29 @@
 
 /**
- * @defgroup mac Mac platform driver.
- * @brief HelenOS Mac platform driver.
+ * @addtogroup mac mac
  * @{
  */

uspace/drv/platform/malta/malta.c

@@ -29 +29 @@
 
 /**
- * @defgroup malta Malta board platform driver.
- * @brief HelenOS Malta board platform driver.
+ * @addtogroup malta
  * @{
  */

uspace/drv/platform/msim/msim.c

@@ -29 +29 @@
 
 /**
- * @defgroup msim MSIM platform driver.
- * @brief HelenOS MSIM platform driver.
+ * @addtogroup msim
  * @{
  */

uspace/drv/platform/pc/pc.c

@@ -28 +28 @@
 
 /**
- * @defgroup pc PC platform driver.
- * @brief HelenOS PC platform driver.
+ * @addtogroup pc pc
  * @{
  */

uspace/drv/platform/ski/ski.c

@@ -28 +28 @@
 
 /**
- * @defgroup ski platform driver.
- * @brief Ski platform driver.
+ * @addtogroup ski ski
  * @{
  */

uspace/drv/platform/sun4u/sun4u.c

@@ -28 +28 @@
 
 /**
- * @defgroup sun4u sun4u platform driver.
- * @brief HelenOS sun4u platform driver.
+ * @addtogroup sun4u sun4u
  * @{
  */

uspace/drv/platform/sun4v/sun4v.c

@@ -28 +28 @@
 
 /**
- * @defgroup sun4v platform driver.
- * @brief Sun4v platform driver.
+ * @addtogroup sun4v sun4v
  * @{
  */