abawo/pico-sdk
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Small typos (#776)

Browse Source
This commit is contained in:
Andrew Scheller 2022-05-03 17:47:48 +01:00 committed by GitHub
parent 1c9f72ba1c
commit 8d43364cfb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 4 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/common/pico_util/include/pico/util/pheap.h
View File

@ -24,13 +24,12 @@ extern "C" {
* Pairing Heap Implementation * Pairing Heap Implementation
* \ingroup pico_util * \ingroup pico_util
* *
* pheap defines a simple pairing heap. the implementation simply tracks array indexes, it is up to * pheap defines a simple pairing heap. The implementation simply tracks array indexes, it is up to
* the user to provide storage for heap entries and a comparison function. * the user to provide storage for heap entries and a comparison function.
* *
* NOTE: this class is not safe for concurrent usage. It should be externally protected. Furthermore * NOTE: This class is not safe for concurrent usage. It should be externally protected. Furthermore
* if used concurrently, the caller needs to protect around their use of the returned id. * if used concurrently, the caller needs to protect around their use of the returned id.
* for example, ph_remove_and_free_head returns the id of an element that is no longer in the heap. * For example, ph_remove_and_free_head returns the id of an element that is no longer in the heap.
*
* The user can still use this to look at the data in their companion array, however obviously further operations * The user can still use this to look at the data in their companion array, however obviously further operations
* on the heap may cause them to overwrite that data as the id may be reused on subsequent operations * on the heap may cause them to overwrite that data as the id may be reused on subsequent operations
* *

2
src/rp2_common/pico_platform/include/pico/platform.h
View File

@ -340,7 +340,7 @@ static inline uint8_t rp2040_rom_version(void) {
/*! \brief No-op function for the body of tight loops /*! \brief No-op function for the body of tight loops
* \ingroup pico_platform * \ingroup pico_platform
* *
* Np-op function intended to be called by any tight hardware polling loop. Using this ubiquitously * No-op function intended to be called by any tight hardware polling loop. Using this ubiquitously
* makes it much easier to find tight loops, but also in the future \#ifdef-ed support for lockup * makes it much easier to find tight loops, but also in the future \#ifdef-ed support for lockup
* debugging might be added * debugging might be added
*/ */