Callback typedefs missing from Doxygen documentation #175

New issue

Closed

opened 2021-02-21 05:21:44 -06:00 by lurch · 1 comment

lurch commented

2021-02-21 05:21:44 -06:00

(Migrated from github.com)

Slightly tangential to #71 , I noticed that there a 6 callback typedefs defined in the SDK:

src/common/pico_time/include/pico/time.h:typedef int64_t (*alarm_callback_t)(alarm_id_t id, void *user_data);
src/rp2_common/hardware_gpio/include/hardware/gpio.h:typedef void (*gpio_irq_callback_t)(uint gpio, uint32_t events);
src/rp2_common/hardware_timer/include/hardware/timer.h:typedef void (*hardware_alarm_callback_t)(uint alarm_num);
src/common/pico_time/include/pico/time.h:typedef bool (*repeating_timer_callback_t)(repeating_timer_t *rt);
src/rp2_common/hardware_clocks/include/hardware/clocks.h:typedef void (*resus_callback_t)(void);
src/rp2_common/hardware_rtc/include/hardware/rtc.h:typedef void (*rtc_callback_t)(void);

4 of these are documented in the Doxygen output:

But these two are missing from the Doxygen output:

gpio_irq_callback_t
rtc_callback_t

Slightly tangential to #71 , I noticed that there a 6 callback typedefs defined in the SDK: ``` src/common/pico_time/include/pico/time.h:typedef int64_t (*alarm_callback_t)(alarm_id_t id, void *user_data); src/rp2_common/hardware_gpio/include/hardware/gpio.h:typedef void (*gpio_irq_callback_t)(uint gpio, uint32_t events); src/rp2_common/hardware_timer/include/hardware/timer.h:typedef void (*hardware_alarm_callback_t)(uint alarm_num); src/common/pico_time/include/pico/time.h:typedef bool (*repeating_timer_callback_t)(repeating_timer_t *rt); src/rp2_common/hardware_clocks/include/hardware/clocks.h:typedef void (*resus_callback_t)(void); src/rp2_common/hardware_rtc/include/hardware/rtc.h:typedef void (*rtc_callback_t)(void); ``` 4 of these _are_ documented in the Doxygen output: * [alarm_callback_t](https://raspberrypi.github.io/pico-sdk-doxygen/group__alarm.html#gade88ed45e9b59ad39d91f17c8709c16a) * [hardware_alarm_callback_t](https://raspberrypi.github.io/pico-sdk-doxygen/group__hardware__timer.html#gaf2ca140ecc0d1e8087b584ed3707b80a) * [repeating_timer_callback_t](https://raspberrypi.github.io/pico-sdk-doxygen/group__repeating__timer.html#ga028fe2b7d00c1927c24131aae7c375f3) * [resus_callback_t](https://raspberrypi.github.io/pico-sdk-doxygen/group__hardware__clocks.html#ga60fddc9bfe13c979c8e3a777d0d89037) But these two are missing from the Doxygen output: * gpio_irq_callback_t * rtc_callback_t

Rows
Columns