From 67db6162a2f78a254bf36b2962f5d639e4eca69e Mon Sep 17 00:00:00 2001 From: Marti Bolivar Date: Tue, 27 Aug 2019 19:12:51 -0600 Subject: [PATCH] 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 --- include/kernel.h | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/include/kernel.h b/include/kernel.h index a52f544d892..3c83c10eab0 100644 --- a/include/kernel.h +++ b/include/kernel.h @@ -255,7 +255,7 @@ static inline void k_object_access_all_grant(void *object) #endif /* !CONFIG_USERSPACE */ /** - * grant a thread access to a kernel object + * Grant a thread access to a kernel object * * The thread will be granted access to the object if the caller is from * 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) __syscall void k_object_access_grant(void *object, struct k_thread *thread); /** - * grant a thread access to a kernel object + * Revoke a thread's access to a kernel object * * The thread will lose access to the object if the caller is from * 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); __syscall void k_object_release(void *object); /** - * grant all present and future threads access to an object + * Grant all present and future threads access to an object * * If the caller is from supervisor mode, or the caller is from user mode and * have sufficient permissions on the object, then that object will have