Skip to content

Commit 67db616

Browse files
mbolivar-nordicioannisg
authored andcommitted
doc: fix doxygen briefs for k_object_xxx APIs
Make the capitalization consistent with that used in k_object_alloc(), and fix a copy/paste error in k_object_access_revoke()'s docstring. Signed-off-by: Marti Bolivar <[email protected]>
1 parent 1e34ea9 commit 67db616

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

include/kernel.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,7 @@ static inline void k_object_access_all_grant(void *object)
255255
#endif /* !CONFIG_USERSPACE */
256256

257257
/**
258-
* grant a thread access to a kernel object
258+
* Grant a thread access to a kernel object
259259
*
260260
* The thread will be granted access to the object if the caller is from
261261
* supervisor mode, or the caller is from user mode AND has permissions
@@ -267,7 +267,7 @@ static inline void k_object_access_all_grant(void *object)
267267
__syscall void k_object_access_grant(void *object, struct k_thread *thread);
268268

269269
/**
270-
* grant a thread access to a kernel object
270+
* Revoke a thread's access to a kernel object
271271
*
272272
* The thread will lose access to the object if the caller is from
273273
* supervisor mode, or the caller is from user mode AND has permissions
@@ -282,7 +282,7 @@ void k_object_access_revoke(void *object, struct k_thread *thread);
282282
__syscall void k_object_release(void *object);
283283

284284
/**
285-
* grant all present and future threads access to an object
285+
* Grant all present and future threads access to an object
286286
*
287287
* If the caller is from supervisor mode, or the caller is from user mode and
288288
* have sufficient permissions on the object, then that object will have

0 commit comments

Comments
 (0)