From 13a171a9716b728ee8086a6330618133b1f83fb2 Mon Sep 17 00:00:00 2001 From: Andrew Scheller Date: Thu, 19 Jan 2023 22:38:14 +0000 Subject: [PATCH] Small doxygen fixes (#1092) --- .../hardware_gpio/include/hardware/gpio.h | 3 +-- src/rp2_common/hardware_irq/include/hardware/irq.h | 2 +- .../pico_cyw43_arch/include/pico/cyw43_arch.h | 14 +++++++------- 3 files changed, 9 insertions(+), 10 deletions(-) diff --git a/src/rp2_common/hardware_gpio/include/hardware/gpio.h b/src/rp2_common/hardware_gpio/include/hardware/gpio.h index a76cb43..ae48075 100644 --- a/src/rp2_common/hardware_gpio/include/hardware/gpio.h +++ b/src/rp2_common/hardware_gpio/include/hardware/gpio.h @@ -476,9 +476,8 @@ static inline uint32_t gpio_get_irq_event_mask(uint gpio) { * the opposite level). * * \param gpio GPIO number - * \param events Bitmask of events to clear. See \ref gpio_set_irq_enabled for details. * - * \note For callbacks set with \ref gpio_set_irq_enabled_with_callback, or \ref gpio_set_irq_callback,this function is called automatically. + * \note For callbacks set with \ref gpio_set_irq_enabled_with_callback, or \ref gpio_set_irq_callback, this function is called automatically. * \param event_mask Bitmask of events to clear. See \ref gpio_irq_level for details. */ void gpio_acknowledge_irq(uint gpio, uint32_t event_mask); diff --git a/src/rp2_common/hardware_irq/include/hardware/irq.h b/src/rp2_common/hardware_irq/include/hardware/irq.h index 9b6aff2..6937f63 100644 --- a/src/rp2_common/hardware_irq/include/hardware/irq.h +++ b/src/rp2_common/hardware_irq/include/hardware/irq.h @@ -256,7 +256,7 @@ void irq_remove_handler(uint num, irq_handler_t handler); * \ingroup hardware_irq * * \param num Interrupt number \ref interrupt_nums - * \param return true if the specified IRQ has a shared handler + * \return true if the specified IRQ has a shared handler */ bool irq_has_shared_handler(uint num); diff --git a/src/rp2_common/pico_cyw43_arch/include/pico/cyw43_arch.h b/src/rp2_common/pico_cyw43_arch/include/pico/cyw43_arch.h index 8d6a628..4e5096f 100644 --- a/src/rp2_common/pico_cyw43_arch/include/pico/cyw43_arch.h +++ b/src/rp2_common/pico_cyw43_arch/include/pico/cyw43_arch.h @@ -124,7 +124,7 @@ extern "C" { * * This method initializes the `cyw43_driver` code and initializes the lwIP stack (if it * was enabled at build time). This method must be called prior to using any other \c pico_cyw43_arch, - * \cyw43_driver or lwIP functions. + * \c cyw43_driver or lwIP functions. * * \note this method initializes wireless with a country code of \c PICO_CYW43_ARCH_DEFAULT_COUNTRY_CODE * which defaults to \c CYW43_COUNTRY_WORLDWIDE. Worldwide settings may not give the best performance; consider @@ -139,7 +139,7 @@ int cyw43_arch_init(void); * * This method initializes the `cyw43_driver` code and initializes the lwIP stack (if it * was enabled at build time). This method must be called prior to using any other \c pico_cyw43_arch, - * \cyw43_driver or lwIP functions. + * \c cyw43_driver or lwIP functions. * * \param country the country code to use (see \ref CYW43_COUNTRY_) * \return 0 if the initialization is successful, an error code otherwise \see pico_error_codes @@ -150,7 +150,7 @@ int cyw43_arch_init_with_country(uint32_t country); * \brief Enables Wi-Fi STA (Station) mode. * \ingroup pico_cyw43_arch * - * This enables the Wi-Fi in \emStation mode such that connections can be made to other Wi-Fi Access Points + * This enables the Wi-Fi in \em Station mode such that connections can be made to other Wi-Fi Access Points */ void cyw43_arch_enable_sta_mode(void); @@ -181,7 +181,7 @@ void cyw43_arch_deinit(void); * \ingroup pico_cyw43_arch * * \param ssid the network name to connect to - * \param password the network password or NULL if there is no password required + * \param pw the network password or NULL if there is no password required * \param auth the authorization type to use when the password is enabled. Values are \ref CYW43_AUTH_WPA_TKIP_PSK, * \ref CYW43_AUTH_WPA2_AES_PSK, or \ref CYW43_AUTH_WPA2_MIXED_PSK (see \ref CYW43_AUTH_) * @@ -194,13 +194,13 @@ int cyw43_arch_wifi_connect_blocking(const char *ssid, const char *pw, uint32_t * \ingroup pico_cyw43_arch * * \param ssid the network name to connect to - * \param password the network password or NULL if there is no password required + * \param pw the network password or NULL if there is no password required * \param auth the authorization type to use when the password is enabled. Values are \ref CYW43_AUTH_WPA_TKIP_PSK, * \ref CYW43_AUTH_WPA2_AES_PSK, or \ref CYW43_AUTH_WPA2_MIXED_PSK (see \ref CYW43_AUTH_) * * \return 0 if the initialization is successful, an error code otherwise \see pico_error_codes */ -int cyw43_arch_wifi_connect_timeout_ms(const char *ssid, const char *pw, uint32_t auth, uint32_t timeout); +int cyw43_arch_wifi_connect_timeout_ms(const char *ssid, const char *pw, uint32_t auth, uint32_t timeout_ms); /*! * \brief Start attempting to connect to a wireless access point @@ -210,7 +210,7 @@ int cyw43_arch_wifi_connect_timeout_ms(const char *ssid, const char *pw, uint32_ * status by calling \ref cyw43_wifi_link_status. * * \param ssid the network name to connect to - * \param password the network password or NULL if there is no password required + * \param pw the network password or NULL if there is no password required * \param auth the authorization type to use when the password is enabled. Values are \ref CYW43_AUTH_WPA_TKIP_PSK, * \ref CYW43_AUTH_WPA2_AES_PSK, or \ref CYW43_AUTH_WPA2_MIXED_PSK (see \ref CYW43_AUTH_) *