Context Navigation

← Previous Change
Next Change →

Changeset 4122410 in mainline for uspace/drv

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

Files:

: 16 added
: 32 edited

bus/isa/doc/doxygroups.h (added)
bus/isa/isa.c (modified) (1 diff)
bus/pci/pciintel/doc/doxygroups.h (added)
bus/pci/pciintel/pci.c (modified) (1 diff)
char/ns8250/doc/doxygroups.h (added)
char/ns8250/ns8250.c (modified) (1 diff)
fb/amdm37x_dispc/amdm37x_dispc.c (modified) (2 diffs)
fb/amdm37x_dispc/amdm37x_dispc.h (modified) (1 diff)
fb/amdm37x_dispc/amdm37x_dispc_regs.h (modified) (1 diff)
fb/amdm37x_dispc/doc/doxygroups.h (added)
fb/amdm37x_dispc/main.c (modified) (1 diff)
platform/amdm37x/amdm37x.c (modified) (2 diffs)
platform/amdm37x/amdm37x.h (modified) (1 diff)
platform/amdm37x/cm/clock_control.h (modified) (1 diff)
platform/amdm37x/cm/core.h (modified) (1 diff)
platform/amdm37x/cm/iva2.h (modified) (1 diff)
platform/amdm37x/cm/mpu.h (modified) (1 diff)
platform/amdm37x/cm/usbhost.h (modified) (1 diff)
platform/amdm37x/doc/doxygroups.h (added)
platform/amdm37x/main.c (modified) (1 diff)
platform/amdm37x/prm/clock_control.h (modified) (1 diff)
platform/amdm37x/prm/global_reg.h (modified) (1 diff)
platform/amdm37x/prm/usbhost.h (modified) (1 diff)
platform/amdm37x/uhh.h (modified) (1 diff)
platform/amdm37x/usbtll.h (modified) (1 diff)
platform/icp/doc/doxygroups.h (added)
platform/icp/icp.c (modified) (1 diff)
platform/mac/doc/doxygroups.h (added)
platform/mac/mac.c (modified) (1 diff)
platform/malta/doc/doxygroups.h (added)
platform/malta/malta.c (modified) (1 diff)
platform/msim/doc/doxygroups.h (added)
platform/msim/msim.c (modified) (1 diff)
platform/pc/doc/doxygroups.h (added)
platform/pc/pc.c (modified) (1 diff)
platform/ski/doc/doxygroups.h (added)
platform/ski/ski.c (modified) (1 diff)
platform/sun4u/doc/doxygroups.h (added)
platform/sun4u/sun4u.c (modified) (1 diff)
platform/sun4v/doc/doxygroups.h (added)
platform/sun4v/sun4v.c (modified) (1 diff)
root/root/doc/doxygroups.h (added)
root/root/root.c (modified) (1 diff)
root/virt/doc/doxygroups.h (added)
root/virt/virt.c (modified) (1 diff)
time/cmos-rtc/cmos-regs.h (modified) (2 diffs)
time/cmos-rtc/cmos-rtc.c (modified) (1 diff)
time/cmos-rtc/doc/doxygroups.h (added)

Legend:

: Unmodified
: Added
: Removed

uspace/drv/bus/isa/isa.c

-              r46f7b64
+              r4122410
 /**
+ * @defgroup isa ISA bus driver.
+ * @brief HelenOS ISA bus driver.
+ * @addtogroup isa
  * @{
  */

uspace/drv/bus/pci/pciintel/pci.c

-              r46f7b64
+              r4122410
 /**
+ * @defgroup pciintel pci bus driver for intel method 1.
+ * @brief HelenOS root pci bus driver for intel method 1.
+ * @addtogroup pciintel
  * @{
  */

uspace/drv/char/ns8250/ns8250.c

-              r46f7b64
+              r4122410
 /**
+ * @defgroup ns8250 Serial port driver.
+ * @brief HelenOS serial port driver.
+ * @addtogroup ns8250
  * @{
  */

uspace/drv/fb/amdm37x_dispc/amdm37x_dispc.c

-              r46f7b64
+              r4122410
  */
 /** @addtogroup amdm37x
+/** @addtogroup amdm37x_dispc
  * @{
  */
 …
         return EOK;
+}
+/**
+ * @}
+ */

uspace/drv/fb/amdm37x_dispc/amdm37x_dispc.h

r46f7b64	r4122410
27	27	*/
28	28
29		/** @addtogroup ~~kgraph~~
	29	/** @addtogroup amdm73x_dispc
30	30	* @{
31	31	*/

uspace/drv/fb/amdm37x_dispc/amdm37x_dispc_regs.h

r46f7b64	r4122410
26	26	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27	27	*/
28		/** @addtogroup ~~genarch~~
	28	/** @addtogroup amdm37x_dispc
29	29	* @{
30	30	*/

uspace/drv/fb/amdm37x_dispc/main.c

r46f7b64	r4122410
28	28	*/
29	29
30		/** @addtogroup amdm37x
	30	/** @addtogroup amdm37x_dispc
31	31	* @{
32	32	*/

uspace/drv/platform/amdm37x/amdm37x.c

-              r46f7b64
+              r4122410
 /**
+ * @defgroup amdm37x TI AM/DM37x platform driver.
+ * @brief HelenOS TI AM/DM37x platform driver.
+ * @addtogroup amdm37x
  * @{
  */
 …
         return EOK;
+}
+/**
+ * @}
+ */

uspace/drv/platform/amdm37x/amdm37x.h

r46f7b64	r4122410
27	27	*/
28	28
29		/** @addtogroup amdm37x~~drv~~
	29	/** @addtogroup amdm37x
30	30	* @{
31	31	*/

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

r46f7b64	r4122410
27	27	*/
28	28
29		/** @addtogroup amdm37x~~drvclockcontrolcm~~
	29	/** @addtogroup amdm37x
30	30	* @{
31	31	*/

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

r46f7b64	r4122410
27	27	*/
28	28
29		/** @addtogroup amdm37x~~drvcorecm~~
	29	/** @addtogroup amdm37x
30	30	* @{
31	31	*/

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

r46f7b64	r4122410
27	27	*/
28	28
29		/** @addtogroup amdm37x~~drvcm~~
	29	/** @addtogroup amdm37x
30	30	* @{
31	31	*/

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

r46f7b64	r4122410
27	27	*/
28	28
29		/** @addtogroup amdm37x~~drvcm~~
	29	/** @addtogroup amdm37x
30	30	* @{
31	31	*/

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

r46f7b64	r4122410
27	27	*/
28	28
29		/** @addtogroup amdm37x~~drvusbhostcm~~
	29	/** @addtogroup amdm37x
30	30	* @{
31	31	*/

uspace/drv/platform/amdm37x/main.c

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

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

r46f7b64	r4122410
27	27	*/
28	28
29		/** @addtogroup amdm37x~~drvprm~~
	29	/** @addtogroup amdm37x
30	30	* @{
31	31	*/

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

r46f7b64	r4122410
27	27	*/
28	28
29		/** @addtogroup amdm37x~~drvprm~~
	29	/** @addtogroup amdm37x
30	30	* @{
31	31	*/

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

r46f7b64	r4122410
27	27	*/
28	28
29		/** @addtogroup amdm37x~~drvprm~~
	29	/** @addtogroup amdm37x
30	30	* @{
31	31	*/

uspace/drv/platform/amdm37x/uhh.h

r46f7b64	r4122410
27	27	*/
28	28
29		/** @addtogroup amdm37x~~drvuhh~~
	29	/** @addtogroup amdm37x
30	30	* @{
31	31	*/

uspace/drv/platform/amdm37x/usbtll.h

r46f7b64	r4122410
27	27	*/
28	28
29		/** @addtogroup amdm37x~~drvusbtll~~
	29	/** @addtogroup amdm37x
30	30	* @{
31	31	*/

uspace/drv/platform/icp/icp.c

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

uspace/drv/platform/mac/mac.c

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

uspace/drv/platform/malta/malta.c

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

uspace/drv/platform/msim/msim.c

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

uspace/drv/platform/pc/pc.c

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

uspace/drv/platform/ski/ski.c

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

uspace/drv/platform/sun4u/sun4u.c

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

uspace/drv/platform/sun4v/sun4v.c

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

uspace/drv/root/root/root.c

-              r46f7b64
+              r4122410
 /**
+ * @defgroup root Root device driver.
+ * @brief HelenOS root device driver.
+ * @addtogroup root
  * @{
  */

uspace/drv/root/virt/virt.c

r46f7b64	r4122410
28	28
29	29	/**
30		* @~~defgroup virt Root device driver for virtual devices.~~
	30	* @addtogroup virt
31	31	* @{
32	32	*/

uspace/drv/time/cmos-rtc/cmos-regs.h

-              r46f7b64
+              r4122410
  */
+/** @addtogroup cmos-rtc
+ * @{
+ */
 #ifndef _CMOS_RTC_H_
 #define _CMOS_RTC_H_
 …
 #endif
+/**
+ * @}
+ */

uspace/drv/time/cmos-rtc/cmos-rtc.c

-              r46f7b64
+              r4122410
 /**
+ * @defgroup CMOS RTC driver.
+ * @brief HelenOS RTC driver.
+ * @addtogroup cmos-rtc
  * @{
  */

Note: See TracChangeset for help on using the changeset viewer.

Context Navigation

Changeset 4122410 in mainline for uspace/drv

Legend:

Download in other formats: