Git rid of some errant apostrophes in Doxygen / code comments (#1275)

This commit is contained in:
Andrew Scheller 2023-02-23 13:37:56 +00:00 committed by GitHub
parent d172067f47
commit 777cd52e21
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 8 additions and 8 deletions

View file

@ -32,7 +32,7 @@
// The linker will store pointers within the binary using their runtime values, however because of // The linker will store pointers within the binary using their runtime values, however because of
// "AT" mapping in the link script these addresses actually correspond to a different address in the binary // "AT" mapping in the link script these addresses actually correspond to a different address in the binary
// image. This mapping (which in the case of crt0.S is simply the data copy table used at initialization // image. This mapping (which in the case of crt0.S is simply the data copy table used at initialization
// to copy data into it's runtime location) can be used by picotool or others to reverse the mapping to find data // to copy data into its runtime location) can be used by picotool or others to reverse the mapping to find data
// within the binary. // within the binary.
// //
// Note the above array is terminated with a NULL source_addr_start // Note the above array is terminated with a NULL source_addr_start
@ -40,4 +40,4 @@
#define BINARY_INFO_MARKER_START 0x7188ebf2 #define BINARY_INFO_MARKER_START 0x7188ebf2
#define BINARY_INFO_MARKER_END 0xe71aa390 #define BINARY_INFO_MARKER_END 0xe71aa390
#endif #endif

View file

@ -66,7 +66,7 @@ extern "C" {
// PICO_CONFIG: PICO_DEFAULT_WS2812_PIN, Optionally define a pin that controls data to a WS2812 compatible LED on the board, group=pico_stdlib // PICO_CONFIG: PICO_DEFAULT_WS2812_PIN, Optionally define a pin that controls data to a WS2812 compatible LED on the board, group=pico_stdlib
// PICO_CONFIG: PICO_DEFAULT_WS2812_POWER_PIN, Optionally define a pin that controls power to a WS2812 compatible LED on the board, group=pico_stdlib // PICO_CONFIG: PICO_DEFAULT_WS2812_POWER_PIN, Optionally define a pin that controls power to a WS2812 compatible LED on the board, group=pico_stdlib
/*! \brief Set up the default UART and assign it to the default GPIO's /*! \brief Set up the default UART and assign it to the default GPIOs
* \ingroup pico_stdlib * \ingroup pico_stdlib
* *
* By default this will use UART 0, with TX to pin GPIO 0, * By default this will use UART 0, with TX to pin GPIO 0,

View file

@ -37,7 +37,7 @@ typedef struct __packed_aligned critical_section {
* The critical section is initialized ready for use, and will use a (possibly shared) spin lock * The critical section is initialized ready for use, and will use a (possibly shared) spin lock
* number assigned by the system. Note that in general it is unlikely that you would be nesting * number assigned by the system. Note that in general it is unlikely that you would be nesting
* critical sections, however if you do so you *must* use \ref critical_section_init_with_lock_num * critical sections, however if you do so you *must* use \ref critical_section_init_with_lock_num
* to ensure that the spin lock's used are different. * to ensure that the spin locks used are different.
* *
* \param crit_sec Pointer to critical_section structure * \param crit_sec Pointer to critical_section structure
*/ */

View file

@ -321,7 +321,7 @@ void irq_remove_handler(uint num, irq_handler_t handler) {
if (next_slot_index >= 0) { if (next_slot_index >= 0) {
// There is another slot in the chain, so copy that over us, so that our inst3 points at something valid // There is another slot in the chain, so copy that over us, so that our inst3 points at something valid
// Note this only matters in the exception case anyway, and it that case, we will skip the next handler, // Note this only matters in the exception case anyway, and it that case, we will skip the next handler,
// however in that case it's IRQ cause should immediately cause re-entry of the IRQ and the only side // however in that case its IRQ cause should immediately cause re-entry of the IRQ and the only side
// effect will be that there was potentially brief out of priority order execution of the handlers // effect will be that there was potentially brief out of priority order execution of the handlers
struct irq_handler_chain_slot *next_slot = &irq_handler_chain_slots[next_slot_index]; struct irq_handler_chain_slot *next_slot = &irq_handler_chain_slots[next_slot_index];
to_free_slot->handler = next_slot->handler; to_free_slot->handler = next_slot->handler;

View file

@ -23,7 +23,7 @@ extern "C" {
* - pll_sys - Used to generate up to a 133MHz system clock * - pll_sys - Used to generate up to a 133MHz system clock
* - pll_usb - Used to generate a 48MHz USB reference clock * - pll_usb - Used to generate a 48MHz USB reference clock
* *
* For details on how the PLL's are calculated, please refer to the RP2040 datasheet. * For details on how the PLLs are calculated, please refer to the RP2040 datasheet.
*/ */
typedef pll_hw_t *PLL; typedef pll_hw_t *PLL;

View file

@ -82,7 +82,7 @@ typedef struct async_context async_context_t;
* \ingroup pico_async_context * \ingroup pico_async_context
* *
* A "timeout" represents some future action that must be taken at a specific time. * A "timeout" represents some future action that must be taken at a specific time.
* It's methods are called from the async_context under lock at the given time * Its methods are called from the async_context under lock at the given time
* *
* \see async_context_add_worker_at * \see async_context_add_worker_at
* \see async_context_add_worker_in_ms * \see async_context_add_worker_in_ms
@ -117,7 +117,7 @@ typedef struct async_work_on_timeout {
* *
* A "worker" represents some external entity that must do work in response * A "worker" represents some external entity that must do work in response
* to some external stimulus (usually an IRQ). * to some external stimulus (usually an IRQ).
* It's methods are called from the async_context under lock at the given time * Its methods are called from the async_context under lock at the given time
* *
* \see async_context_add_worker_at * \see async_context_add_worker_at
* \see async_context_add_worker_in_ms * \see async_context_add_worker_in_ms