michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: fix doxygen briefs for k_object_xxx APIs

Browse source 
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 <marti.bolivar@nordicsemi.no>
This commit is contained in:
Marti Bolivar 2019-08-27 19:12:51 -06:00 • committed by Ioannis Glaropoulos
commit 67db6162a2
1 changed files with 3 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

6
include/kernel.h
View file

@ -255,7 +255,7 @@ static inline void k_object_access_all_grant(void *object)
#endif /* !CONFIG_USERSPACE */ #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 * 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 * 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); __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 * 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 * 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); __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 * 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 * have sufficient permissions on the object, then that object will have