Comment documentation fixes.

libntfs/dir.c

@@ -600,8 +600,7 @@ static const ntfschar dotdot[3] = { const_cpu_to_le16('.'),
 				   const_cpu_to_le16('\0') };
 
 /*
- * union index_union -
- * More helpers for ntfs_readdir().
+ * union index_union - Helper for ntfs_readdir().
  */
 typedef union {
 	INDEX_ROOT *ir;
@@ -609,8 +608,7 @@ typedef union {
 } index_union __attribute__((__transparent_union__));
 
 /**
- * enum INDEX_TYPE -
- * More helpers for ntfs_readdir().
+ * enum INDEX_TYPE - Helper for ntfs_readdir().
  */
 typedef enum {
 	INDEX_TYPE_ROOT,	/* index root */
@@ -1446,7 +1444,7 @@ ntfs_inode *ntfs_create_symlink(ntfs_inode *dir_ni, ntfschar *name, u8 name_len,
 
 /**
  * ntfs_delete - delete file or directory from ntfs volume
- * @ni:		ntfs inode for object to delte
+ * @ni:		ntfs inode for object to delete
  * @dir_ni:	ntfs inode for directory in which delete object
  * @name:	unicode name of the object to delete
  * @name_len:	length of the name in unicode characters

libntfs/index.c

@@ -1261,6 +1261,8 @@ static int ntfs_ir_insert_median(ntfs_index_context *icx, INDEX_ENTRY *median,
 static int ntfs_ib_split(ntfs_index_context *icx, INDEX_BLOCK *ib);
 
 /**
+ * ntfs_ib_insert - insert an index block to an index context.
+ *
  * On success return STATUS_OK or STATUS_KEEP_SEARCHING.
  * On error return STATUS_ERROR.
  */
@@ -1490,8 +1492,10 @@ out:
 }
 
 /**
- *  Used if an empty index block to be deleted has END entry as the parent
- *  in the INDEX_ROOT which is the only one there.
+ * ntfs_ir_leafify -
+ * 
+ * Used if an empty index block to be deleted has END entry as the parent
+ * in the INDEX_ROOT which is the only one there.
  */
 static void ntfs_ir_leafify(ntfs_index_context *icx, INDEX_HEADER *ih)
 {
@@ -1514,8 +1518,10 @@ static void ntfs_ir_leafify(ntfs_index_context *icx, INDEX_HEADER *ih)
 }
 
 /**
- *  Used if an empty index block to be deleted has END entry as the parent 
- *  in the INDEX_ROOT which is not the only one there.
+ * ntfs_ih_reparent_end -
+ *
+ * Used if an empty index block to be deleted has END entry as the parent 
+ * in the INDEX_ROOT which is not the only one there.
  */
 static int ntfs_ih_reparent_end(ntfs_index_context *icx, INDEX_HEADER *ih,
 				INDEX_BLOCK *ib)

libntfs/logging.c

@@ -69,8 +69,7 @@ struct ntfs_logging {
 };
 
 /**
- * ntfs_log
- * This struct controls all the logging within the library and tools.
+ * ntfs_log - This struct controls all the logging in the library and tools.
  */
 static struct ntfs_logging ntfs_log = {
 #ifdef DEBUG

libntfs/unistr.c

@@ -741,7 +741,7 @@ ntfschar *ntfs_str2ucs(const char *s, int *len)
 
 /**
  * ntfs_ucsfree - free memory allocated by ntfs_str2ucs()
- * @ucs		input string to be freed
+ * @ucs:	input string to be freed
  *
  * Free memory at @ucs and which was allocated by ntfs_str2ucs.
  *

ntfsprogs/mkntfs.c

@@ -585,9 +585,10 @@ static long long mkntfs_write(struct ntfs_device *dev,
 }
 
 /**
- * ntfs_rlwrite - Write to disk the clusters contained in the runlist @rl
- * taking the data from @val.  Take @val_len bytes from @val and pad the
- * rest with zeroes.
+ * ntfs_rlwrite - Write data to disk on clusters found in a runlist.
+ *
+ * Write to disk the clusters contained in the runlist @rl taking the data
+ * from @val.  Take @val_len bytes from @val and pad the rest with zeroes.
  *
  * If the @rl specifies a completely sparse file, @val is allowed to be NULL.
  *
@@ -1478,6 +1479,7 @@ static int mkntfs_attr_lookup(const ATTR_TYPES type, const ntfschar *name,
 
 /**
  * insert_positioned_attr_in_mft_record
+ *
  * Create a non-resident attribute with a predefined on disk location
  * specified by the runlist @rl. The clusters specified by @rl are assumed to
  * be allocated already.

ntfsprogs/ntfsdecrypt.c

@@ -1189,8 +1189,10 @@ static int ntfs_fek_decrypt_sector(ntfs_fek *fek, u8 *data, const u64 offset)
 }
 
 /**
- * ntfs_cat_decrypt
- * TODO:
+ * ntfs_cat_decrypt - Decrypt the contents of an encrypted file to stdout.
+ * @inode:	An encrypted file's inode structure, as obtained by
+ * 		ntfs_inode_open().
+ * @fek:	A file encryption key. As obtained by ntfs_inode_fek_get().
  */
 static int ntfs_cat_decrypt(ntfs_inode *inode, ntfs_fek *fek)
 {

ntfsprogs/ntfsmove.c

@@ -746,7 +746,8 @@ static s64 move_datarun(ntfs_volume *vol, ntfs_inode *ino, ATTR_RECORD *rec,
 }
 
 /**
- * move_attribute
+ * move_attribute -
+ *
  * > 0  Bytes moved / size to be moved
  * = 0  Nothing to do
  * < 0  Error
@@ -791,7 +792,8 @@ static s64 move_attribute(ntfs_volume *vol, ntfs_inode *ino, ATTR_RECORD *rec,
 }
 
 /**
- * move_file
+ * move_file -
+ *
  * > 0  Bytes moved / size to be moved
  * = 0  Nothing to do
  * < 0  Error

ntfsprogs/sd.c

@@ -202,6 +202,7 @@ void init_system_file_sd(int sys_file_no, u8 **sd_val, int *sd_val_len)
 
 /**
  * init_root_sd_31 (ERSO)
+ *
  * creates the security_descriptor for the root folder on ntfs 3.1.
  * It is very long; lots of ACE's at first, then large pieces of zeroes;
  * the owner user/group is near the end. On a partition created with