From cc20f806681fca52f44036bf6a831891a4eec367 Mon Sep 17 00:00:00 2001 From: fincs Date: Mon, 29 Jan 2018 00:08:49 +0100 Subject: [PATCH] Documentation: address second batch of comments (#38) --- nx/include/switch/kernel/shmem.h | 4 ++-- nx/include/switch/kernel/tmem.h | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/nx/include/switch/kernel/shmem.h b/nx/include/switch/kernel/shmem.h index 12ccdd95..b40af1b6 100644 --- a/nx/include/switch/kernel/shmem.h +++ b/nx/include/switch/kernel/shmem.h @@ -21,7 +21,7 @@ typedef struct { * @param s Shared memory information structure which will be filled in. * @param size Size of the shared memory object to create. * @param local_perm Permissions with which the shared memory object will be mapped in the local process. - * @param remote_perm Permissions with which the shared memory object will be mapped in the remote process. + * @param remote_perm Permissions with which the shared memory object will be mapped in the remote process (can be Perm_DontCare). * @return Result code. * @warning This is a privileged operation; in normal circumstances applications cannot use this function. */ @@ -31,7 +31,7 @@ Result shmemCreate(SharedMemory* s, size_t size, Permission local_perm, Permissi * @brief Loads a shared memory object coming from a remote process. * @param s Shared memory information structure which will be filled in. * @param handle Handle of the shared memory object. - * @param size Size of the shared memory object to create. + * @param size Size of the shared memory object that is being loaded. * @param perm Permissions with which the shared memory object will be mapped in the local process. */ void shmemLoadRemote(SharedMemory* s, Handle handle, size_t size, Permission perm); diff --git a/nx/include/switch/kernel/tmem.h b/nx/include/switch/kernel/tmem.h index e893424c..24e68586 100644 --- a/nx/include/switch/kernel/tmem.h +++ b/nx/include/switch/kernel/tmem.h @@ -21,7 +21,7 @@ typedef struct { * @brief Creates a transfer memory object. * @param t Transfer memory information structure that will be filled in. * @param size Size of the transfer memory object to create. - * @param perm Permissions to assign to the transfer memory object. + * @param perm Permissions with which to protect the transfer memory in the local process. * @return Result code. */ Result tmemCreate(TransferMemory* t, size_t size, Permission perm); @@ -30,8 +30,8 @@ Result tmemCreate(TransferMemory* t, size_t size, Permission perm); * @brief Loads a transfer memory object coming from a remote process. * @param t Transfer memory information structure which will be filled in. * @param handle Handle of the transfer memory object. - * @param size Size of the transfer memory object to create. - * @param perm Permissions with which the transfer memory object will be mapped in the local process. + * @param size Size of the transfer memory object that is being loaded. + * @param perm Permissions which the transfer memory is expected to have in the process that owns the memory. * @warning This is a privileged operation; in normal circumstances applications shouldn't use this function. */ void tmemLoadRemote(TransferMemory* t, Handle handle, size_t size, Permission perm);