[rtems commit] arm: csb336: Add doxygen
Gedare Bloom
gedare at rtems.org
Sun Dec 8 18:05:40 UTC 2013
Module: rtems
Branch: master
Commit: a0390782dc32de0e6271ddfbf99cf00b7ea7f6c2
Changeset: http://git.rtems.org/rtems/commit/?id=a0390782dc32de0e6271ddfbf99cf00b7ea7f6c2
Author: Chirayu Desai <cdesai at cyanogenmod.org>
Date: Sun Dec 8 10:41:54 2013 +0530
arm: csb336: Add doxygen
---
c/src/lib/libbsp/arm/csb336/include/bsp.h | 24 +++++++++++++++++++++-
c/src/lib/libbsp/arm/csb336/network/lan91c11x.c | 8 +++++++
c/src/lib/libbsp/arm/csb336/network/lan91c11x.h | 8 +++++++
3 files changed, 38 insertions(+), 2 deletions(-)
diff --git a/c/src/lib/libbsp/arm/csb336/include/bsp.h b/c/src/lib/libbsp/arm/csb336/include/bsp.h
index f68b0e3..5d19800 100644
--- a/c/src/lib/libbsp/arm/csb336/include/bsp.h
+++ b/c/src/lib/libbsp/arm/csb336/include/bsp.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup arm_csb336
+ *
+ * @brief Global BSP definitions.
+ */
+
/*
* BSP CSB336 header file
*
@@ -24,6 +32,16 @@ extern "C" {
#include <rtems/clockdrv.h>
#include <mc9328mxl.h>
+/**
+ * @defgroup arm_csb336 CSB336 Support
+ *
+ * @ingroup bsp_arm
+ *
+ * @brief CSB336 support package.
+ *
+ * @{
+ */
+
#define BSP_FEATURE_IRQ_EXTENSION
/* What is the input clock freq in hertz? */
@@ -32,8 +50,8 @@ extern "C" {
int get_perclk1_freq(void);
-/*
- * Network driver configuration
+/**
+ * @brief Network driver configuration
*/
extern struct rtems_bsdnet_ifconfig *config;
@@ -43,6 +61,8 @@ int rtems_mc9328mxl_enet_attach(struct rtems_bsdnet_ifconfig *config,
#define RTEMS_BSP_NETWORK_DRIVER_NAME "eth0"
#define RTEMS_BSP_NETWORK_DRIVER_ATTACH rtems_mc9328mxl_enet_attach
+/** @} */
+
#ifdef __cplusplus
}
#endif
diff --git a/c/src/lib/libbsp/arm/csb336/network/lan91c11x.c b/c/src/lib/libbsp/arm/csb336/network/lan91c11x.c
index 023f010..001aa00 100644
--- a/c/src/lib/libbsp/arm/csb336/network/lan91c11x.c
+++ b/c/src/lib/libbsp/arm/csb336/network/lan91c11x.c
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup arm_csb336
+ *
+ * @brief Helper functions for SMSC LAN91C11x
+ */
+
/*
* Helper functions for SMSC LAN91C11x
*
diff --git a/c/src/lib/libbsp/arm/csb336/network/lan91c11x.h b/c/src/lib/libbsp/arm/csb336/network/lan91c11x.h
index 4742f04..abf7c24 100644
--- a/c/src/lib/libbsp/arm/csb336/network/lan91c11x.h
+++ b/c/src/lib/libbsp/arm/csb336/network/lan91c11x.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup arm_csb336
+ *
+ * @brief SMSC LAN91C11x ethernet devices definitions.
+ */
+
/*
* Header file for SMSC LAN91C11x ethernet devices
*
More information about the vc
mailing list