Skip to content

PICO_DEFAULT_TIMER docs refer to rp2040 instead of rp2350. #2761

@BlockListed

Description

@BlockListed

The docs for PICO_DEFAULT_TIMER currently state:

/**
 * \ingroup hardware_timer
 * \brief The default timer instance number of the timer instance used for APIs that don't take an explicit timer instance
 * \if rp2040_specific
 * On RP2040 this must be 0 as there is only one timer instance
 * \endif
 * \if rp2350_specific
 * On RP2040 this may be set to 0 or 1
 * \endif
 */

They should state:

/**
 * \ingroup hardware_timer
 * \brief The default timer instance number of the timer instance used for APIs that don't take an explicit timer instance
 * \if rp2040_specific
 * On RP2040 this must be 0 as there is only one timer instance
 * \endif
 * \if rp2350_specific
 * On RP2350 this may be set to 0 or 1
 * \endif
 */

Note the \if rp2350_specific clause.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions