arm/altera-cyclone-v doxygen patch

[Sebastian Huber]

On 08/11/2018 21:18, Gedare Bloom wrote:
>
>
> On Thu, Nov 8, 2018 at 1:42 AM, Sebastian Huber 
> <sebastian.huber at embedded-brains.de 
> <mailto:sebastian.huber at embedded-brains.de>> wrote:
>
>     On 08/11/2018 04:52, Gedare Bloom wrote:
>
>         Attached is a patch from GCI 2018 adding doxygen to the
>         altera-cyclone-v.
>
>         6545323948244992_1541638792_0001-arm-altera-cyclone-v-Update-Doxygen-GCI-2018.patch
>
>          From f69a935ea34fb617cab4632830e60184fe380d30 Mon Sep 17
>         00:00:00 2001
>         From: shashvatjain<shashvatjain2002 at gmail.com
>         <mailto:shashvatjain2002 at gmail.com>>
>         Date: Thu, 8 Nov 2018 06:17:49 +0530
>         Subject: [PATCH] arm/altera cyclone v: Update Doxygen (GCI 2018)
>
>         ---
>           bsps/arm/altera-cyclone-v/i2c/i2cdrv-config.h | 9 ++++++++
>           bsps/arm/altera-cyclone-v/include/bsp.h       | 18
>         +++++++++++++++
>           bsps/arm/altera-cyclone-v/include/bsp/hwlib.h | 16
>         ++++++++++++++
>           .../arm/altera-cyclone-v/include/bsp/i2cdrv.h | 17
>         ++++++++++++++
>           bsps/arm/altera-cyclone-v/include/bsp/irq.h   | 22
>         ++++++++++++++++++-
>           5 files changed, 81 insertions(+), 1 deletion(-)
>
>         diff --git a/bsps/arm/altera-cyclone-v/i2c/i2cdrv-config.h
>         b/bsps/arm/altera-cyclone-v/i2c/i2cdrv-config.h
>         index 650974751e..529d19980f 100644
>         --- a/bsps/arm/altera-cyclone-v/i2c/i2cdrv-config.h
>         +++ b/bsps/arm/altera-cyclone-v/i2c/i2cdrv-config.h
>         @@ -1,3 +1,12 @@
>         +/**
>         + * @file
>         + *
>         + * @ingroup altera-cyclone-v_i2c
>
>
>     I think CamelCase is used in most places for Doxygen internal names.
>
>
> 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.

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.

-- 
Sebastian Huber, embedded brains GmbH

Address : Dornierstr. 4, D-82178 Puchheim, Germany
Phone   : +49 89 189 47 41-16
Fax     : +49 89 189 47 41-09
E-Mail  : sebastian.huber at embedded-brains.de
PGP     : Public key available on request.

Diese Nachricht ist keine geschäftliche Mitteilung im Sinne des EHUG.