aboutsummaryrefslogtreecommitdiff
path: root/include/apos/mem_regions.h
diff options
context:
space:
mode:
authorKimplul <kimi.h.kuparinen@gmail.com>2022-06-09 23:50:14 +0300
committerKimplul <kimi.h.kuparinen@gmail.com>2022-06-09 23:50:14 +0300
commitda8eeb7695a4803d1d45c8c26c05a51fb1ba1e55 (patch)
tree85323057da02893e351426c60f2c5cfd5603b428 /include/apos/mem_regions.h
parente30cd339e271b0d16dbecf6c521fa06c3a05e3f1 (diff)
downloadkmi-da8eeb7695a4803d1d45c8c26c05a51fb1ba1e55.tar.gz
kmi-da8eeb7695a4803d1d45c8c26c05a51fb1ba1e55.zip
continue documentation
Diffstat (limited to 'include/apos/mem_regions.h')
-rw-r--r--include/apos/mem_regions.h8
1 files changed, 4 insertions, 4 deletions
diff --git a/include/apos/mem_regions.h b/include/apos/mem_regions.h
index 2eaef8c..0651bfe 100644
--- a/include/apos/mem_regions.h
+++ b/include/apos/mem_regions.h
@@ -96,7 +96,7 @@ struct mem_region {
* @param start Start of memory arena.
* @param arena_size Size of memory arena.
* @return \ref OK on success.
- * @todo Document error codes when I actually implement them properly.
+ * \todo Document error codes when I actually implement them properly.
*/
stat_t init_region(struct mem_region_root *r, vm_t start, size_t arena_size);
@@ -156,7 +156,7 @@ stat_t free_region(struct mem_region_root *r, vm_t start);
* @param r Memory region root.
* @param m Memory region to free.
* @return \ref OK.
- * @todo Improve error checking.
+ * \todo Improve error checking.
*/
stat_t free_known_region(struct mem_region_root *r, struct mem_region *m);
@@ -231,7 +231,7 @@ typedef stat_t region_callback_t(struct vmem *vmem, pm_t *offset, vm_t vaddr,
* @param va Address that is within memory region.
* @param flags Memory region flags.
* @return \ref OK when succesful.
- * @todo Implement.
+ * \todo Implement.
*/
stat_t stat_region(struct mem_region_root *r, vm_t va, vmflags_t *flags);
@@ -242,7 +242,7 @@ stat_t stat_region(struct mem_region_root *r, vm_t va, vmflags_t *flags);
* @param va Address that is within memory region.
* @param flags New flags of region.
* @return \ref OK when succesful.
- * @todo Implement.
+ * \todo Implement.
*/
stat_t mod_region(struct mem_region_root *r, vm_t va, vmflags_t flags);