continue documentation

6 files changed, 11 insertions, 11 deletions

diff --git a/arch/riscv64/config.h b/arch/riscv64/config.h
index 3d70248..ba7fafe 100644
--- a/arch/riscv64/config.h
+++ b/arch/riscv64/config.h
@@ -11,8 +11,8 @@
  * instead. First 4K is reserved for NULL, but I suppose it could be mapped
  * later if *absolutely* necessary.
  *
- * @todo Consider separating user-specified and immutable parameters.
- * @todo Write more thorough documentation, maybe a separate .md file?
+ * \todo Consider separating user-specified and immutable parameters.
+ * \todo Write more thorough documentation, maybe a separate .md file?
  */
 
 #include <apos/sizes.h>
@@ -75,7 +75,7 @@
 #else
 /* 32bit */
 
-/* TODO: figure this stuff out */
+/* \todo: figure this stuff out */
 #define VM_DMAP (0x000000000)
 #define VM_KERN (VM_DMAP + SZ_256K)
 #define ROOT_PTE (0UL)
diff --git a/arch/riscv64/kernel/power.c b/arch/riscv64/kernel/power.c
index 73500bb..160cf25 100644
--- a/arch/riscv64/kernel/power.c
+++ b/arch/riscv64/kernel/power.c
@@ -28,7 +28,7 @@
 
 stat_t poweroff(enum poweroff_type type)
 {
-	/* TODO: this only shuts down the cpu itself, but may leave the SOC
+	/* \todo: this only shuts down the cpu itself, but may leave the SOC
 	 * active. Should read from fdt poweroff and syscon-poweroff etc */
 	switch (type) {
 	case SHUTDOWN:
diff --git a/arch/riscv64/kernel/proc.c b/arch/riscv64/kernel/proc.c
index 85c7bb2..b3a1ca7 100644
--- a/arch/riscv64/kernel/proc.c
+++ b/arch/riscv64/kernel/proc.c
@@ -8,7 +8,7 @@
 #include "regs.h"
 #include "csr.h"
 
-/* TODO: actually map fdt into the target address space */
+/* \todo: actually map fdt into the target address space */
 stat_t run_init(struct tcb *t, void *fdt)
 {
 	csr_write(CSR_SSCRATCH, t);
@@ -36,7 +36,7 @@ stat_t set_ipc(struct tcb *t, id_t pid, id_t tid)
 stat_t set_thread(struct tcb *t, vm_t stack)
 {
 	/* get location of registers in memory */
-	/* TODO: check alignment, should be fine but just to be sure */
+	/* \todo: check alignment, should be fine but just to be sure */
 	struct riscv_regs *r = (struct riscv_regs *)(--t);
 
 	/* insert important values into register slots */
diff --git a/arch/riscv64/kernel/regs.h b/arch/riscv64/kernel/regs.h
index bda3c1d..fafc84d 100644
--- a/arch/riscv64/kernel/regs.h
+++ b/arch/riscv64/kernel/regs.h
@@ -7,7 +7,7 @@
  * _save_context. Used in \ref arch/riscv64/gen/asm-offsets.c to generate a list
  * of offsets usable from assembly.
  *
- * @todo Implement sacing floating point, vector, etc. registers.
+ * \todo Implement sacing floating point, vector, etc. registers.
  */
 
 /**
diff --git a/arch/riscv64/kernel/sbi.h b/arch/riscv64/kernel/sbi.h
index 3ffac05..36497f1 100644
--- a/arch/riscv64/kernel/sbi.h
+++ b/arch/riscv64/kernel/sbi.h
@@ -50,7 +50,7 @@ enum sbi_ecodes {
  * @param arg4 Argument 4.
  * @param arg5 Argument 5.
  * @return SBI call return. \see sbiret.
- * @todo Query which extensions are available.
+ * \todo Query which extensions are available.
  */
 struct sbiret sbi_ecall(int ext, int fid, unsigned long arg0,
                         unsigned long arg1, unsigned long arg2,
@@ -68,7 +68,7 @@ struct sbiret sbi_ecall(int ext, int fid, unsigned long arg0,
  *
  * @param stime_value Absolute timepoint in ticks.
  * @return SBI call return. \see sbiret.
- * @todo Read timebase from fdt, seems to be clocks/sec for accurate timers.
+ * \todo Read timebase from fdt, seems to be clocks/sec for accurate timers.
  */
 static inline struct sbiret sbi_set_timer(uint64_t stime_value)
 {
@@ -94,7 +94,7 @@ static inline struct sbiret sbi_set_timer(uint64_t stime_value)
  * @param reset_reason Reason for reset. Optional, probably won't be used by the
  * kernel.
  * @return SBI call return \see sbiret.
- * @todo Should \ref SBI_SHUTDOWN etc. be defined in this file instead?
+ * \todo Should \ref SBI_SHUTDOWN etc. be defined in this file instead?
  */
 static inline struct sbiret sbi_system_reset(uint32_t reset_type,
                                              uint32_t reset_reason)
diff --git a/arch/riscv64/kernel/vmem.c b/arch/riscv64/kernel/vmem.c
index 1c825e1..deafb6a 100644
--- a/arch/riscv64/kernel/vmem.c
+++ b/arch/riscv64/kernel/vmem.c
@@ -223,7 +223,7 @@ vm_t setup_kernel_io(struct vmem *b, vm_t paddr)
 
 stat_t clone_uvmem(struct vmem *r, struct vmem *b)
 {
-	/* TODO: error checking? */
+	/* \todo: error checking? */
 	for (size_t i = 0; i <= CSTACK_PAGE; ++i)
 		b->leaf[i] = r->leaf[i];