- oops forgot includes
[oweals/gnunet.git] / src / include / gnunet_disk_lib.h
index d364568b648dc8184cee02e57001edf2ec304737..51f58565542b96f5fb98439fd8071cac66fde3ac 100644 (file)
  */
 struct GNUNET_DISK_PipeHandle;
 
-
+/**
+ * Type of a handle.
+ */
 enum GNUNET_FILE_Type
 {
-  GNUNET_DISK_FILE, GNUNET_PIPE
+  /**
+   * Handle represents a file.
+   */ 
+  GNUNET_DISK_HANLDE_TYPE_FILE, 
+
+  /**
+   * Handle represents a pipe.
+   */
+  GNUNET_DISK_HANLDE_TYPE_PIPE
 };
 
 /**
@@ -356,15 +366,13 @@ GNUNET_DISK_mktemp (const char *t);
 
 
 /**
- * Create an (empty) temporary file on disk.  If the given name is not
- * an absolute path, the current 'TMPDIR' will be prepended.  In any case,
- * 6 random characters will be appended to the name to create a unique
- * filename.
+ * Create an (empty) temporary directory on disk.  If the given name is not an
+ * absolute path, the current 'TMPDIR' will be prepended.  In any case, 6
+ * random characters will be appended to the name to create a unique name.
  *
  * @param t component to use for the name;
  *        does NOT contain "XXXXXX" or "/tmp/".
- * @return NULL on error, otherwise name of fresh
- *         file on disk in directory for temporary files
+ * @return NULL on error, otherwise name of freshly created directory
  */
 char *
 GNUNET_DISK_mkdtemp (const char *t);