Standardise references to the Raspberry Pi Pico SDK
This commit is contained in:
committed by
Graham Sanderson
parent
705f1ae59f
commit
3e52e57f5f
@ -10,7 +10,7 @@
|
||||
/** \file pico.h
|
||||
* \defgroup pico_base pico_base
|
||||
*
|
||||
* Core types and macros for the Pico SDK. This header is intended to be included by all source code
|
||||
* Core types and macros for the Raspberry Pi Pico SDK. This header is intended to be included by all source code
|
||||
*/
|
||||
|
||||
#include "pico/types.h"
|
||||
|
@ -20,7 +20,7 @@ extern "C" {
|
||||
/** \file stdlib.h
|
||||
* \defgroup pico_stdlib pico_stdlib
|
||||
*
|
||||
* Aggregation of a core subset of Pico SDK libraries used by most executables along with some additional
|
||||
* Aggregation of a core subset of Raspberry Pi Pico SDK libraries used by most executables along with some additional
|
||||
* utility methods. Including pico_stdlib gives you everything you need to get a basic program running
|
||||
* which prints to stdout or flashes a LED
|
||||
*
|
||||
|
@ -20,7 +20,7 @@ extern "C" {
|
||||
* API for accurate timestamps, sleeping, and time based callbacks
|
||||
*
|
||||
* \note The functions defined here provide a much more powerful and user friendly wrapping around the
|
||||
* low level hardware timer functionality. For these functions (and any other Pico SDK functionality
|
||||
* low level hardware timer functionality. For these functions (and any other SDK functionality
|
||||
* e.g. timeouts, that relies on them) to work correctly, the hardware timer should not be modified. i.e. it is expected
|
||||
* to be monotonically increasing once per microsecond. Fortunately there is no need to modify the hardware
|
||||
* timer as any functionality you can think of that isn't already covered here can easily be modelled
|
||||
@ -355,7 +355,7 @@ void alarm_pool_init_default();
|
||||
#if !PICO_TIME_DEFAULT_ALARM_POOL_DISABLED
|
||||
/*!
|
||||
* \brief The default alarm pool used when alarms are added without specifying an alarm pool,
|
||||
* and also used by the Pico SDK to support lower power sleeps and timeouts.
|
||||
* and also used by the SDK to support lower power sleeps and timeouts.
|
||||
*
|
||||
* \ingroup alarm
|
||||
* \sa #PICO_TIME_DEFAULT_ALARM_POOL_HARDWARE_ALARM_NUM
|
||||
|
Reference in New Issue
Block a user