Here is the patch in the attachment adding Doxygen header to specified.h
files
at this link
https://github.com/joelsherrill/gci_tasks/blob/master/2018/doxygen_c_header_tasks/file_lists/arm_atsam_Add_Doxygen_Headers_Task_00.txt
I cannot find header in "/arm/atsam/include/bsp.h" in my source tree , does
it really exist?
From 9ed027ea116e8d3f92cd32bdb7b9a0e3e94241bd Mon Sep 17 00:00:00 2001
From: shashvatjain <shashvatjain2002@gmail.com>
Date: Fri, 9 Nov 2018 19:39:09 +0530
Subject: [PATCH] arm/atsam: Update Doxygen (GCI 2018)
---
bsps/arm/atsam/include/bsp.h | 18 ++++++++++++++++++
.../arm/atsam/include/bsp/atsam-clock-config.h | 17 +++++++++++++++++
bsps/arm/atsam/include/bsp/atsam-i2c.h | 16 ++++++++++++++++
bsps/arm/atsam/include/bsp/atsam-spi.h | 16 ++++++++++++++++
bsps/arm/atsam/include/bsp/i2c.h | 8 ++++++++
bsps/arm/atsam/include/bsp/iocopy.h | 16 ++++++++++++++++
bsps/arm/atsam/include/bsp/irq.h | 16 ++++++++++++++++
bsps/arm/atsam/include/bsp/pin-config.h | 16 ++++++++++++++++
bsps/arm/atsam/include/bsp/spi.h | 8 ++++++++
bsps/arm/atsam/include/tm27.h | 9 +++++++++
10 files changed, 140 insertions(+)
diff --git a/bsps/arm/atsam/include/bsp.h b/bsps/arm/atsam/include/bsp.h
index cd0103ad70..0a2062e5bd 100644
--- a/bsps/arm/atsam/include/bsp.h
+++ b/bsps/arm/atsam/include/bsp.h
@@ -1,3 +1,12 @@
+/**
+ *@file
+ *
+ *@ingroup arm_atsam
+ *
+ *@brief Global BSP Definitions.
+ *
+ */
+
/*
* Copyright (c) 2016 embedded brains GmbH. All rights reserved.
*
@@ -24,6 +33,15 @@
extern "C" {
#endif /* __cplusplus */
+/**
+ *@defgroup arm_atsam Atsam Support
+ *
+ *@ingroup bsp_arm
+ *
+ *@brief Atsam Support Package.
+ *
+ */
+
#define BSP_FEATURE_IRQ_EXTENSION
#define BSP_ARMV7M_IRQ_PRIORITY_DEFAULT (13 << 4)
diff --git a/bsps/arm/atsam/include/bsp/atsam-clock-config.h b/bsps/arm/atsam/include/bsp/atsam-clock-config.h
index 396986894b..508610f951 100644
--- a/bsps/arm/atsam/include/bsp/atsam-clock-config.h
+++ b/bsps/arm/atsam/include/bsp/atsam-clock-config.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup atsam_clock
+ *
+ * @brief Clock Driver Configuration.
+ */
+
/*
* Copyright (c) 2017 embedded brains GmbH. All rights reserved.
*
@@ -23,6 +31,15 @@
extern "C" {
#endif /* __cplusplus */
+/**
+ *@defgroup atsam_clock Clock Support
+ *
+ *@ingroup arm_atsam
+ *
+ *@brief Clock Package.
+ *
+ */
+
#if ATSAM_CHANGE_CLOCK_FROM_SRAM != 0
/* Note: fast_text is the simplest section to put this code into. Other
* possibilities would include creating a new section. */
diff --git a/bsps/arm/atsam/include/bsp/atsam-i2c.h b/bsps/arm/atsam/include/bsp/atsam-i2c.h
index ae0fe97584..5787937ceb 100644
--- a/bsps/arm/atsam/include/bsp/atsam-i2c.h
+++ b/bsps/arm/atsam/include/bsp/atsam-i2c.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup atsam_i2c
+ *
+ * @brief I2C Support.
+ */
+
/*
* Copyright (c) 2016 embedded brains GmbH. All rights reserved.
*
@@ -26,6 +34,14 @@
extern "C" {
#endif /* __cplusplus */
+/**
+ * @defgroup atsam_i2c I2C Support
+ *
+ * @ingroup arm_atsam
+ *
+ * @brief I2C Support.
+ */
+
#define TWI_AMOUNT_PINS 2
typedef enum {
diff --git a/bsps/arm/atsam/include/bsp/atsam-spi.h b/bsps/arm/atsam/include/bsp/atsam-spi.h
index 4bfa6c3a1e..8bf92d8576 100644
--- a/bsps/arm/atsam/include/bsp/atsam-spi.h
+++ b/bsps/arm/atsam/include/bsp/atsam-spi.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup atsam_spi
+ *
+ * @brief SPI Support
+ */
+
/*
* Copyright (c) 2016 embedded brains GmbH. All rights reserved.
*
@@ -21,6 +29,14 @@
extern "C" {
#endif /* __cplusplus */
+/**
+ * @defgroup atsam_spi SPI Support
+ *
+ * @ingroup arm_atsam
+ *
+ * @brief SPI Support
+ */
+
typedef struct {
uint8_t spi_peripheral_id;
const Pin *pins;
diff --git a/bsps/arm/atsam/include/bsp/i2c.h b/bsps/arm/atsam/include/bsp/i2c.h
index 1ea1204ff5..ab22494a87 100644
--- a/bsps/arm/atsam/include/bsp/i2c.h
+++ b/bsps/arm/atsam/include/bsp/i2c.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup atsam_i2c
+ *
+ * @brief I2C Support.
+ */
+
/*
* Copyright (c) 2016 embedded brains GmbH. All rights reserved.
*
diff --git a/bsps/arm/atsam/include/bsp/iocopy.h b/bsps/arm/atsam/include/bsp/iocopy.h
index 27e374747e..2925aa89e7 100644
--- a/bsps/arm/atsam/include/bsp/iocopy.h
+++ b/bsps/arm/atsam/include/bsp/iocopy.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup atsam_iocopy
+ *
+ * @brief Functions For Copying.
+ */
+
/*
* Copyright (c) 2018 embedded brains GmbH. All rights reserved.
*
@@ -22,6 +30,14 @@
extern "C" {
#endif /* __cplusplus */
+/**
+ * @defgroup atsam_iocopy IOCOPY Support
+ *
+ * @ingroup arm_atsam
+ *
+ * @brief IOCOPY Support
+ */
+
/*
* Note: This functions are for copying from or to memory that is marked as
* Peripheral memory. In this regions a misaligned access is not allowed.
diff --git a/bsps/arm/atsam/include/bsp/irq.h b/bsps/arm/atsam/include/bsp/irq.h
index 19370e4852..c0d7ab9ad5 100644
--- a/bsps/arm/atsam/include/bsp/irq.h
+++ b/bsps/arm/atsam/include/bsp/irq.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup atsam_interrupt
+ *
+ * @brief Interrupt Support.
+ */
+
/*
* Copyright (c) 2016 embedded brains GmbH. All rights reserved.
*
@@ -28,3 +36,11 @@
#define BSP_INTERRUPT_VECTOR_MAX 64
#endif /* LIBBSP_ARM_ATSAM_ESV_70_IRQ_H */
+
+/**
+ * @defgroup atsam_interrupt Interrrupt Support
+ *
+ * @ingroup arm_atsam
+ *
+ * @brief Interrupt Support.
+ */
diff --git a/bsps/arm/atsam/include/bsp/pin-config.h b/bsps/arm/atsam/include/bsp/pin-config.h
index 8f4a61428f..6eaf4daf63 100644
--- a/bsps/arm/atsam/include/bsp/pin-config.h
+++ b/bsps/arm/atsam/include/bsp/pin-config.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup atsam_pin
+ *
+ * @brief
+ */
+
/*
* Copyright (c) 2016 embedded brains GmbH. All rights reserved.
*
@@ -34,3 +42,11 @@ extern const uint32_t atsam_matrix_ccfg_sysio;
#endif /* __cplusplus */
#endif /* LIBBSP_ARM_ATSAM_PIN_CONFIG_H */
+
+/**
+ * @defgroup atsam_pin Pin Support
+ *
+ * @ingroup arm_atsam
+ *
+ * @brief Pin support.
+ */
diff --git a/bsps/arm/atsam/include/bsp/spi.h b/bsps/arm/atsam/include/bsp/spi.h
index 958e629ba3..004e2803a2 100644
--- a/bsps/arm/atsam/include/bsp/spi.h
+++ b/bsps/arm/atsam/include/bsp/spi.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup atsam_spi
+ *
+ * @brief SPI Support.
+ */
+
/*
* Copyright (c) 2016 embedded brains GmbH. All rights reserved.
*
diff --git a/bsps/arm/atsam/include/tm27.h b/bsps/arm/atsam/include/tm27.h
index 0dfa7bf628..259e6989cc 100644
--- a/bsps/arm/atsam/include/tm27.h
+++ b/bsps/arm/atsam/include/tm27.h
@@ -1 +1,10 @@
+/**
+ *@file
+ *
+ *@ingroup arm_atsam
+ *
+ *@brief Implementations of interrupt mechanisms for Time Test 27.
+ *
+ */
+
#include <rtems/tm27-default.h>
--
2.17.1
_______________________________________________
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel
