[riot-notifications] [RIOT-OS/RIOT] cpu: fix doxygen grouping warnings (#16813)

Marian Buschsieweke notifications at github.com
Mon Sep 6 16:16:18 CEST 2021


@maribu commented on this pull request.

looks good to me, some comments inline

> @@ -30,6 +30,7 @@ extern "C" {
 
 /**
  * @brief Overwrite the default gpio_t type definition

If I recall correctly, grouping only works with `@name` instead of `@brief`

> + * @brief   ADC resolution values
+ * @{

```suggestion
 * @name   ADC resolution values
 * @{
```

same

> +/**
+ * @brief   ADC resolution values.
+ */

Note that this is hidden from Doxygen anyway. (IMO this is sensible to do for all `adc_rec_t` definitions except for the default in `drivers/include/periph/adc.h`.)

Maybe it makes more sense to just drop the doc for this type instead?

-- 
You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub:
https://github.com/RIOT-OS/RIOT/pull/16813#pullrequestreview-747259184
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.riot-os.org/pipermail/notifications/attachments/20210906/17b68ab6/attachment-0001.htm>


More information about the notifications mailing list