<div dir="ltr">Thanks Sebastian, I had the same question about the two groups, and I'll check the generated Doxygen for that when I can.</div><div class="gmail_extra"><br><div class="gmail_quote">On Thu, Nov 8, 2018 at 1:42 AM, Sebastian Huber <span dir="ltr"><<a href="mailto:sebastian.huber@embedded-brains.de" target="_blank">sebastian.huber@embedded-brains.de</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><span class="">On 08/11/2018 04:52, Gedare Bloom wrote:<br>
</span><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><span class="">
Attached is a patch from GCI 2018 adding doxygen to the altera-cyclone-v.<br>
<br></span>
6545323948244992_1541638792_00<wbr>01-arm-altera-cyclone-v-Update<wbr>-Doxygen-GCI-2018.patch<br>
<br>
From f69a935ea34fb617cab4632830e601<wbr>84fe380d30 Mon Sep 17 00:00:00 2001<br>
From: shashvatjain<<a href="mailto:shashvatjain2002@gmail.com" target="_blank">shashvatjain2002@<wbr>gmail.com</a>><br>
Date: Thu, 8 Nov 2018 06:17:49 +0530<br>
Subject: [PATCH] arm/altera cyclone v: Update Doxygen (GCI 2018)<br>
<br>
---<br>
bsps/arm/altera-cyclone-v/i2c/<wbr>i2cdrv-config.h | 9 ++++++++<br>
bsps/arm/altera-cyclone-v/incl<wbr>ude/bsp.h | 18 +++++++++++++++<br>
bsps/arm/altera-cyclone-v/incl<wbr>ude/bsp/hwlib.h | 16 ++++++++++++++<br>
.../arm/altera-cyclone-v/inclu<wbr>de/bsp/i2cdrv.h | 17 ++++++++++++++<br>
bsps/arm/altera-cyclone-v/incl<wbr>ude/bsp/irq.h | 22 ++++++++++++++++++-<br>
5 files changed, 81 insertions(+), 1 deletion(-)<br>
<br>
diff --git a/bsps/arm/altera-cyclone-v/i2<wbr>c/i2cdrv-config.h b/bsps/arm/altera-cyclone-v/i2<wbr>c/i2cdrv-config.h<br>
index 650974751e..529d19980f 100644<br>
--- a/bsps/arm/altera-cyclone-v/i2<wbr>c/i2cdrv-config.h<br>
+++ b/bsps/arm/altera-cyclone-v/i2<wbr>c/i2cdrv-config.h<br>
@@ -1,3 +1,12 @@<br>
+/**<br>
+ * @file<br>
+ *<br>
+ * @ingroup altera-cyclone-v_i2c<br>
</blockquote>
<br>
I think CamelCase is used in most places for Doxygen internal names.<br>
<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
+ *<br>
+ * @brief Drivers for I2C<br>
+ *<br>
+ */<br>
+<br>
/*<br>
* Copyright (c) 2014 embedded brains GmbH. All rights reserved.<br>
*<br>
diff --git a/bsps/arm/altera-cyclone-v/in<wbr>clude/bsp.h b/bsps/arm/altera-cyclone-v/in<wbr>clude/bsp.h<br>
index 860a15c5bf..92bc95531b 100644<br>
--- a/bsps/arm/altera-cyclone-v/in<wbr>clude/bsp.h<br>
+++ b/bsps/arm/altera-cyclone-v/in<wbr>clude/bsp.h<br>
@@ -1,3 +1,11 @@<br>
+/**<br>
+ * @file<br>
+ *<br>
+ * @ingroup arm_altera-cyclone-v<br>
+ *<br>
+ * @brief Global BSP definitions.<br>
+ */<br>
+<br>
/*<br>
* Copyright (c) 2013, 2018 embedded brains GmbH. All rights reserved.<br>
*<br>
@@ -50,3 +58,13 @@ extern "C" {<br>
#endif /* ASM */<br>
#endif /* LIBBSP_ARM_ALTERA_CYCLONE_V_BS<wbr>P_H */<br>
+<br>
+/**<br>
+ * @defgroup arm_altera-cyclone-v Altera Cyclone V Support<br>
+ *<br>
+ * @ingroup bsp_arm<br>
+ *<br>
+ * @brief Altera Cyclone V support package.<br>
+ *<br>
+ * @{<br>
+ */<br>
diff --git a/bsps/arm/altera-cyclone-v/in<wbr>clude/bsp/hwlib.h b/bsps/arm/altera-cyclone-v/in<wbr>clude/bsp/hwlib.h<br>
index aba7e877c4..8aad5d7b32 100644<br>
--- a/bsps/arm/altera-cyclone-v/in<wbr>clude/bsp/hwlib.h<br>
+++ b/bsps/arm/altera-cyclone-v/in<wbr>clude/bsp/hwlib.h<br>
@@ -1,3 +1,11 @@<br>
+/**<br>
+ * @file<br>
+ *<br>
+ * @ingroup altera-cyclone-v_hwlib<br>
+ *<br>
+ * @brief The type definition for status codes returned by the HWLIB.<br>
+ */<br>
+<br>
/*****************************<wbr>******************************<wbr>*******************<br>
*<br>
* Copyright 2013 Altera Corporation. All Rights Reserved.<br>
@@ -48,6 +56,14 @@ extern "C"<br>
{<br>
#endif /* __cplusplus */<br>
+/**<br>
+ * @defgroup altera-cyclone-v_hwlib Hwlib<br>
+ *<br>
+ * @ingroup arm_altera-cyclone-v<br>
+ *<br>
+ * @brief The type definition for status codes returned by the HWLIB.<br>
+ */<br>
+<br>
/*!<br>
* The type definition for status codes returned by the HWLIB.<br>
*/<br>
diff --git a/bsps/arm/altera-cyclone-v/in<wbr>clude/bsp/i2cdrv.h b/bsps/arm/altera-cyclone-v/in<wbr>clude/bsp/i2cdrv.h<br>
index 9a4411d637..114d8a6219 100644<br>
--- a/bsps/arm/altera-cyclone-v/in<wbr>clude/bsp/i2cdrv.h<br>
+++ b/bsps/arm/altera-cyclone-v/in<wbr>clude/bsp/i2cdrv.h<br>
@@ -1,3 +1,11 @@<br>
+/**<br>
+ * @file<br>
+ *<br>
+ * @ingroup altera-cyclone-v_i2c<br>
+ *<br>
+ * @brief Drivers for I2C<br>
+ */<br>
+<br>
/*<br>
* Copyright (c) 2014 embedded brains GmbH. All rights reserved.<br>
*<br>
@@ -21,6 +29,15 @@<br>
extern "C" {<br>
#endif /* __cplusplus */<br>
+/**<br>
+ * @defgroup altera-cyclone-v_i2c I2C Support<br>
+ *<br>
+ * @ingroup arm_altera-cyclone-v<br>
+ *<br>
+ * @brief I2C Support<br>
+ *<br>
+ */<br>
+<br>
rtems_device_driver i2cdrv_initialize(<br>
rtems_device_major_number major,<br>
rtems_device_minor_number minor,<br>
diff --git a/bsps/arm/altera-cyclone-v/in<wbr>clude/bsp/irq.h b/bsps/arm/altera-cyclone-v/in<wbr>clude/bsp/irq.h<br>
index c136500415..f7455af9b4 100644<br>
--- a/bsps/arm/altera-cyclone-v/in<wbr>clude/bsp/irq.h<br>
+++ b/bsps/arm/altera-cyclone-v/in<wbr>clude/bsp/irq.h<br>
@@ -1,3 +1,11 @@<br>
+/**<br>
+ * @file<br>
+ *<br>
+ * @ingroup altera-cyclone-v_interrupt<br>
+ *<br>
+ * @brief Interrupt definitions.<br>
+ */<br>
+<br>
/*<br>
* Copyright (c) 2013 embedded brains GmbH. All rights reserved.<br>
*<br>
@@ -28,6 +36,18 @@<br>
extern "C" {<br>
#endif /* __cplusplus */<br>
+/**<br>
+ * @defgroup altera-cyclone-v_interrupt Interrupt Support<br>
+ *<br>
+ * @ingroup arm_altera-cyclone-v<br>
+ *<br>
+ * @ingroup bsp_interrupt<br>
</blockquote>
<br>
Does it work to place it into two groups?<br>
<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
+ *<br>
+ * @brief Interrupt Support for Altera cyclone V<br>
</blockquote>
<br>
Cyclone<br>
<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
+ *<br>
+ * @{<br>
+ */<br>
+<br>
/* Use interrupt IDs as defined in alt_interrupt_common.h */<br>
#define BSP_INTERRUPT_VECTOR_MIN ALT_INT_INTERRUPT_SGI0<br>
#define BSP_INTERRUPT_VECTOR_MAX ALT_INT_INTERRUPT_RAM_ECC_UNCO<wbr>RRECTED_IRQ<br>
@@ -38,4 +58,4 @@ extern "C" {<br>
#endif /* ASM */<br>
-#endif /* LIBBSP_ARM_ALTERA_CYCLONE_V_IR<wbr>Q_H */<br>
\ No newline at end of file<br>
+#endif /* LIBBSP_ARM_ALTERA_CYCLONE_V_IR<wbr>Q_H */<br>
-- 2.17.1<span class="HOEnZb"><font color="#888888"><br>
</font></span></blockquote><span class="HOEnZb"><font color="#888888">
<br>
-- <br>
Sebastian Huber, embedded brains GmbH<br>
<br>
Address : Dornierstr. 4, D-82178 Puchheim, Germany<br>
Phone : +49 89 189 47 41-16<br>
Fax : +49 89 189 47 41-09<br>
E-Mail : <a href="mailto:sebastian.huber@embedded-brains.de" target="_blank">sebastian.huber@embedded-brain<wbr>s.de</a><br>
PGP : Public key available on request.<br>
<br>
Diese Nachricht ist keine geschäftliche Mitteilung im Sinne des EHUG.<br>
<br>
</font></span></blockquote></div><br></div>