From: John Hodge <tpg@mutabah.net>
Date: Sat, 10 May 2014 05:14:59 +0000 (+0800)
Subject: Kernel - (minor) Documentation comment tweaks
X-Git-Url: https://git.ucc.asn.au/?p=tpg%2Facess2.git;a=commitdiff_plain;h=2d0ff68ffa86fd91feb584580a78dff18d2734c0

Kernel - (minor) Documentation comment tweaks
---

diff --git a/KernelLand/Kernel/include/acess.h b/KernelLand/Kernel/include/acess.h
index fe1a0f97..de16818d 100644
--- a/KernelLand/Kernel/include/acess.h
+++ b/KernelLand/Kernel/include/acess.h
@@ -85,11 +85,11 @@ extern const char	gsBuildInfo[];
  * \{
  * \todo Move to mm_virt.h
  */
-#define	MM_PFLAG_RO		0x01	// Writes disallowed
-#define	MM_PFLAG_EXEC	0x02	// Allow execution
-#define	MM_PFLAG_NOPAGE	0x04	// Prevent from being paged out
-#define	MM_PFLAG_COW	0x08	// Copy-On-Write
-#define	MM_PFLAG_KERNEL	0x10	// Kernel-Only (Ring0)
+#define	MM_PFLAG_RO	0x01	//!< Writes disallowed
+#define	MM_PFLAG_EXEC	0x02	//!< Allow execution
+#define	MM_PFLAG_NOPAGE	0x04	//!< Prevent from being paged out
+#define	MM_PFLAG_COW	0x08	//!< Copy-On-Write
+#define	MM_PFLAG_KERNEL	0x10	//!< Kernel-Only (Ring0)
 /**
  * \}
  */
@@ -143,7 +143,9 @@ typedef struct sKernelSymbol {
  * \name IRQ hander registration
  * \{
  */
+//! Register a callback for when an IRQ is raised
 extern int	IRQ_AddHandler(int Num, void (*Callback)(int, void*), void *Ptr);
+//! Remove a previously registered IRQ handler
 extern void	IRQ_RemHandler(int Handle);
 /**
  * \}
diff --git a/KernelLand/Kernel/include/acess_string.h b/KernelLand/Kernel/include/acess_string.h
index 12e9ba47..b6407932 100644
--- a/KernelLand/Kernel/include/acess_string.h
+++ b/KernelLand/Kernel/include/acess_string.h
@@ -10,7 +10,7 @@
 #include <stdarg.h>
 
 /**
- * \name Strings
+ * \name String Manipulation
  * \{
  */
 // - stdio.h in userland
@@ -38,6 +38,7 @@ extern unsigned long	strtoul(const char *str, char **end, int base);
 extern signed long long	strtoll(const char *str, char **end, int base);
 extern signed long	strtol(const char *str, char **end, int base);
 
+//! \brief String comparison (case-insensitive)
 extern int	strucmp(const char *Str1, const char *Str2);
 extern int	strpos(const char *Str, char Ch);
 extern int	strpos8(const char *str, Uint32 search);
diff --git a/KernelLand/Kernel/include/apidoc_mainpage.h b/KernelLand/Kernel/include/apidoc_mainpage.h
index 8b5b85fb..7a5e427d 100644
--- a/KernelLand/Kernel/include/apidoc_mainpage.h
+++ b/KernelLand/Kernel/include/apidoc_mainpage.h
@@ -23,6 +23,8 @@
  *    user.
  *  - Drivers for specific types of hardware must behave in the specific
  *    way described here.
+ * - \ref library	"Library Functions"
+ *  - Kernel's version of libc and other helper functions
  * 
  * \page drivers Device Drivers
  *