<div dir="ltr"><br><div class="gmail_extra"><br><div class="gmail_quote">On Fri, Nov 9, 2018 at 9:03 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">On 08/11/2018 21:18, Gedare Bloom wrote:<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><span class="">
<br>
<br>
On Thu, Nov 8, 2018 at 1:42 AM, Sebastian Huber <<a href="mailto:sebastian.huber@embedded-brains.de" target="_blank">sebastian.huber@embedded-brai<wbr>ns.de</a> <mailto:<a href="mailto:sebastian.huber@embedded-brains.de" target="_blank">sebastian.huber@embedd<wbr>ed-brains.de</a>>> wrote:<br>
<br>
On 08/11/2018 04:52, Gedare Bloom wrote:<br>
<br>
Attached is a patch from GCI 2018 adding doxygen to the<br>
altera-cyclone-v.<br>
<br>
6545323948244992_1541638792_00<wbr>01-arm-altera-cyclone-v-Update<wbr>-Doxygen-GCI-2018.patch<br>
<br>
From f69a935ea34fb617cab4632830e601<wbr>84fe380d30 Mon Sep 17<br>
00:00:00 2001<br>
From: shashvatjain<<a href="mailto:shashvatjain2002@gmail.com" target="_blank">shashvatjain2002@<wbr>gmail.com</a><br></span>
<mailto:<a href="mailto:shashvatjain2002@gmail.com" target="_blank">shashvatjain2002@gmail<wbr>.com</a>>><div><div class="h5"><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>
+++++++++++++++<br>
bsps/arm/altera-cyclone-v/incl<wbr>ude/bsp/hwlib.h | 16<br>
++++++++++++++<br>
.../arm/altera-cyclone-v/inclu<wbr>de/bsp/i2cdrv.h | 17<br>
++++++++++++++<br>
bsps/arm/altera-cyclone-v/incl<wbr>ude/bsp/irq.h | 22<br>
++++++++++++++++++-<br>
5 files changed, 81 insertions(+), 1 deletion(-)<br>
<br>
diff --git 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>
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>
<br>
<br>
I think CamelCase is used in most places for Doxygen internal names.<br>
<br>
<br>
It appears we have not been doing this in the BSPs doxygen so far. A decision should be made whether to start doing it this way (and fix the ones that are there), or to use the underscores like the other BSP doxygen does.<br>
</div></div></blockquote>
<br>
CamelCase is used throughout the cpukit. The good thing with CamelCase for the Doxygen stuff is that there are no conflicts with C scope identifiers since we don't use CamelCase in source code.<div class="HOEnZb"><div class="h5"><br></div></div></blockquote><div><br></div><div>I chatted this over with Joel. We think it will be best to merge a few more GCI efforts that add the bsp using this underscore notation (we have about 5 pending), and then we'll generate GCI tasks to convert the BSP doxygen to use CamelCase before we add more doxygen to remaining BSPs.</div><div><br></div><div>I can confirm that two @ingroup works. </div><div> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div class="HOEnZb"><div class="h5">
<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>
</div></div></blockquote></div><br></div></div>