aboutsummaryrefslogtreecommitdiff
path: root/include/arch
diff options
context:
space:
mode:
authorKimplul <kimi.h.kuparinen@gmail.com>2022-11-13 15:15:22 +0200
committerKimplul <kimi.h.kuparinen@gmail.com>2022-11-13 15:15:22 +0200
commite6dc962ef7758c438039d7f8ac7e2bf3ebcb5c10 (patch)
tree9484a801bc205e0e5f921ebeaba0a15e4d561400 /include/arch
parentb36e3b83b402ee054c319f0472b16a2bd64bba7e (diff)
downloadkmi-e6dc962ef7758c438039d7f8ac7e2bf3ebcb5c10.tar.gz
kmi-e6dc962ef7758c438039d7f8ac7e2bf3ebcb5c10.zip
improve documentation on new features
Diffstat (limited to 'include/arch')
-rw-r--r--include/arch/vmem.h5
1 files changed, 4 insertions, 1 deletions
diff --git a/include/arch/vmem.h b/include/arch/vmem.h
index f6660ed..c829629 100644
--- a/include/arch/vmem.h
+++ b/include/arch/vmem.h
@@ -53,6 +53,8 @@ stat_t unmap_vpage(struct vmem *branch, vm_t vaddr);
* @param branch Branch in which to work.
* @param vaddr Virtual address of page.
* @param flags Flags to set.
+ * @return \ref ERR_NF if no page could be found at \p vaddr,
+ * \ref INFO_SEFF if modification has side effects, otherwise \ref OK.
*/
stat_t set_vpage_flags(struct vmem *branch, vm_t vaddr, vmflags_t flags);
@@ -62,6 +64,8 @@ stat_t set_vpage_flags(struct vmem *branch, vm_t vaddr, vmflags_t flags);
* @param branch Branch in which to work.
* @param vaddr Virtual address of page.
* @param flags Flags to clear.
+ * @return \ref ERR_NF if no page could be found at \p vaddr,
+ * \ref INFO_SEFF if modification has side effects, otherwise \ref OK.
*/
stat_t clear_vpage_flags(struct vmem *branch, vm_t vaddr, vmflags_t flags);
@@ -157,7 +161,6 @@ stat_t destroy_vmem(struct vmem *b);
*
* @param r Source virtual memory of clone.
* @param b Destination virtual memory of clone.
- * @return \ref OK.
*/
void clone_uvmem(struct vmem *r, struct vmem *b);