From e6dc962ef7758c438039d7f8ac7e2bf3ebcb5c10 Mon Sep 17 00:00:00 2001 From: Kimplul Date: Sun, 13 Nov 2022 15:15:22 +0200 Subject: improve documentation on new features --- include/arch/vmem.h | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) (limited to 'include/arch') 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); -- cgit v1.3