X-Git-Url: https://git.ucc.asn.au/?a=blobdiff_plain;f=Kernel%2Finclude%2Ffs_devfs.h;h=c099fc6c864ea6f7e32ba4a98c2b8be0150a3ea0;hb=02b341123f87f8a395c3cb10d390ae54a7fc53fd;hp=4b29cf1be15a6d29eabeb24582b9f2262e1840ed;hpb=8bc40333b1401d7616b225945fee53d972c2f418;p=tpg%2Facess2.git

diff --git a/Kernel/include/fs_devfs.h b/Kernel/include/fs_devfs.h
index 4b29cf1b..c099fc6c 100644
--- a/Kernel/include/fs_devfs.h
+++ b/Kernel/include/fs_devfs.h
@@ -1,20 +1,35 @@
-/*
- * Acess 2
- * Device Filesystem (DevFS)
- * - vfs/fs/devfs.c
+/**
+ * \file fs_devfs.h
+ * \brief Acess Device Filesystem interface
+ * \author John Hodge (thePowersGang)
  */
 #ifndef _FS_DEVFS_H
 #define _FS_DEVFS_H
 #include <vfs.h>
 
 // === TYPES ===
-typedef struct sDevFS_Driver {
-	struct sDevFS_Driver	*Next;
-	char	*Name;
-	tVFS_Node	RootNode;
+/**
+ * \brief DevFS driver definition
+ */
+typedef struct sDevFS_Driver
+{
+	struct sDevFS_Driver	*Next;	//!< Set to NULL by drivers (used internally)
+	const char	*Name;	//!< Name of the driver file/folder (must be unique)
+	tVFS_Node	RootNode;	//!< Root node of driver
 } tDevFS_Driver;
 
 // === FUNCTIONS ===
-extern int	DevFS_AddDevice(tDevFS_Driver *Dev);
+/**
+ * \fn int DevFS_AddDevice(tDevFS_Driver *Device)
+ * \brief Registers a device in the Device Filesystem
+ * \param Device	Pointer to a persistant structure that represents the driver
+ * \return Boolean success
+ */
+extern int	DevFS_AddDevice(tDevFS_Driver *Device);
+
+/**
+ * \brief Unregisters a device with the Device Filesystem
+ */
+extern void	DevFS_DelDevice(tDevFS_Driver *Device);
 
 #endif