Skip to content

Commit 60c5a92

Browse files
authored
Remove <b> from mutex doxygen due to PDF generation bug
1 parent d0af70b commit 60c5a92

File tree

1 file changed

+8
-8
lines changed
  • src/common/pico_sync/include/pico

1 file changed

+8
-8
lines changed

src/common/pico_sync/include/pico/mutex.h

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ void recursive_mutex_enter_blocking(recursive_mutex_t *mtx);
106106
*
107107
* If the mutex wasn't owned, this will claim the mutex for the caller and return true.
108108
* Otherwise (if the mutex was already owned) this will return false and the
109-
* caller will *NOT* own the mutex.
109+
* caller will NOT own the mutex.
110110
*
111111
* \param mtx Pointer to mutex structure
112112
* \param owner_out If mutex was already owned, and this pointer is non-zero, it will be filled in with the owner id of the current owner of the mutex
@@ -119,7 +119,7 @@ bool mutex_try_enter(mutex_t *mtx, uint32_t *owner_out);
119119
*
120120
* If the mutex wasn't owned or was owned by the caller, this will claim the mutex and return true.
121121
* Otherwise (if the mutex was already owned by another owner) this will return false and the
122-
* caller will *NOT* own the mutex.
122+
* caller will NOT own the mutex.
123123
*
124124
* \param mtx Pointer to recursive mutex structure
125125
* \param owner_out If mutex was already owned by another owner, and this pointer is non-zero,
@@ -133,7 +133,7 @@ bool recursive_mutex_try_enter(recursive_mutex_t *mtx, uint32_t *owner_out);
133133
*
134134
* Wait for up to the specific time to take ownership of the mutex. If the caller
135135
* can be granted ownership of the mutex before the timeout expires, then true will be returned
136-
* and the caller will own the mutex, otherwise false will be returned and the caller will *NOT* own the mutex.
136+
* and the caller will own the mutex, otherwise false will be returned and the caller will NOT own the mutex.
137137
*
138138
* \param mtx Pointer to mutex structure
139139
* \param timeout_ms The timeout in milliseconds.
@@ -147,7 +147,7 @@ bool mutex_enter_timeout_ms(mutex_t *mtx, uint32_t timeout_ms);
147147
* Wait for up to the specific time to take ownership of the recursive mutex. If the caller
148148
* already has ownership of the mutex or can be granted ownership of the mutex before the timeout expires,
149149
* then true will be returned and the caller will own the mutex, otherwise false will be returned and the caller
150-
* will *NOT* own the mutex.
150+
* will NOT own the mutex.
151151
*
152152
* \param mtx Pointer to recursive mutex structure
153153
* \param timeout_ms The timeout in milliseconds.
@@ -161,7 +161,7 @@ bool recursive_mutex_enter_timeout_ms(recursive_mutex_t *mtx, uint32_t timeout_m
161161
* Wait for up to the specific time to take ownership of the mutex. If the caller
162162
* can be granted ownership of the mutex before the timeout expires, then true will be returned
163163
* and the caller will own the mutex, otherwise false will be returned and the caller
164-
* will *NOT* own the mutex.
164+
* will NOT own the mutex.
165165
*
166166
* \param mtx Pointer to mutex structure
167167
* \param timeout_us The timeout in microseconds.
@@ -175,7 +175,7 @@ bool mutex_enter_timeout_us(mutex_t *mtx, uint32_t timeout_us);
175175
* Wait for up to the specific time to take ownership of the recursive mutex. If the caller
176176
* already has ownership of the mutex or can be granted ownership of the mutex before the timeout expires,
177177
* then true will be returned and the caller will own the mutex, otherwise false will be returned and the caller
178-
* will *NOT* own the mutex.
178+
* will NOT own the mutex.
179179
*
180180
* \param mtx Pointer to mutex structure
181181
* \param timeout_us The timeout in microseconds.
@@ -189,7 +189,7 @@ bool recursive_mutex_enter_timeout_us(recursive_mutex_t *mtx, uint32_t timeout_u
189189
* Wait until the specific time to take ownership of the mutex. If the caller
190190
* can be granted ownership of the mutex before the timeout expires, then true will be returned
191191
* and the caller will own the mutex, otherwise false will be returned and the caller
192-
* will *NOT* own the mutex.
192+
* will NOT own the mutex.
193193
*
194194
* \param mtx Pointer to mutex structure
195195
* \param until The time after which to return if the caller cannot be granted ownership of the mutex
@@ -203,7 +203,7 @@ bool mutex_enter_block_until(mutex_t *mtx, absolute_time_t until);
203203
* Wait until the specific time to take ownership of the mutex. If the caller
204204
* already has ownership of the mutex or can be granted ownership of the mutex before the timeout expires,
205205
* then true will be returned and the caller will own the mutex, otherwise false will be returned and the caller
206-
* will *NOT* own the mutex.
206+
* will NOT own the mutex.
207207
*
208208
* \param mtx Pointer to recursive mutex structure
209209
* \param until The time after which to return if the caller cannot be granted ownership of the mutex

0 commit comments

Comments
 (0)