From 83b9eddfc989e21facac72b2afb1585a154747b9 Mon Sep 17 00:00:00 2001 From: flatcap Date: Wed, 2 Nov 2005 17:34:08 +0000 Subject: [PATCH] provide some meaningful function descriptions --- libntfs/attrib.c | 6 ++--- libntfs/bitmap.c | 18 ++++++------- libntfs/collate.c | 6 ++--- libntfs/compat.c | 2 +- libntfs/dir.c | 20 +++++++-------- libntfs/index.c | 16 ++++++------ libntfs/inode.c | 12 ++++----- libntfs/mft.c | 12 ++++----- libntfs/rich.c | 6 ++--- libntfs/runlist.c | 20 +++++++-------- libntfs/tree.c | 64 +++++++++++++++++++++++------------------------ libntfs/unistr.c | 6 ++--- libntfs/unix_io.c | 20 +++++++-------- libntfs/volume.c | 14 +++++------ ntfsprogs/utils.c | 2 +- 15 files changed, 112 insertions(+), 112 deletions(-) diff --git a/libntfs/attrib.c b/libntfs/attrib.c index 5465118e..1bec4aeb 100644 --- a/libntfs/attrib.c +++ b/libntfs/attrib.c @@ -59,7 +59,7 @@ ntfschar AT_UNNAMED[] = { const_cpu_to_le16('\0') }; /** - * ntfs_get_attribute_value_length - + * ntfs_get_attribute_value_length - Find the length of an attribute * @a: * * Description... @@ -82,7 +82,7 @@ s64 ntfs_get_attribute_value_length(const ATTR_RECORD *a) } /** - * ntfs_get_attribute_value - + * ntfs_get_attribute_value - Get a copy of an attribute * @vol: * @a: * @b: @@ -2967,7 +2967,7 @@ int ntfs_attr_add(ntfs_inode *ni, ATTR_TYPES type, /* @val is mandatory. */ if (!val) { ntfs_log_trace("val is mandatory for always resident " - "atributes.\n"); + "attributes.\n"); errno = EINVAL; return -1; } diff --git a/libntfs/bitmap.c b/libntfs/bitmap.c index 495f2bb6..d3444d4d 100644 --- a/libntfs/bitmap.c +++ b/libntfs/bitmap.c @@ -228,7 +228,7 @@ int ntfs_bitmap_clear_run(ntfs_attr *na, s64 start_bit, s64 count) #include "rich.h" /** - * ntfs_bmp_rollback - + * ntfs_bmp_rollback - Discard the in-memory bitmap changes * @bmp: * * Description... @@ -257,7 +257,7 @@ int ntfs_bmp_rollback(struct ntfs_bmp *bmp) } /** - * ntfs_bmp_commit - + * ntfs_bmp_commit - Write the cached bitmap data to disk * @bmp: * * Description... @@ -311,7 +311,7 @@ int ntfs_bmp_commit(struct ntfs_bmp *bmp) } /** - * ntfs_bmp_free - + * ntfs_bmp_free - Destroy a bitmap object * @bmp: * * Description... @@ -332,7 +332,7 @@ void ntfs_bmp_free(struct ntfs_bmp *bmp) } /** - * ntfs_bmp_create - + * ntfs_bmp_create - Create a representation of a bitmap * @inode: * @type: * @name: @@ -372,7 +372,7 @@ struct ntfs_bmp * ntfs_bmp_create(ntfs_inode *inode, ATTR_TYPES type, ntfschar * } /** - * ntfs_bmp_add_data - + * ntfs_bmp_add_data - Add a bitmap block to the current cache * @bmp: * @vcn: * @data: @@ -416,7 +416,7 @@ int ntfs_bmp_add_data(struct ntfs_bmp *bmp, VCN vcn, u8 *data) } /** - * ntfs_bmp_get_data - + * ntfs_bmp_get_data - Ask for a bitmap block from the cache * @bmp: * @vcn: * @@ -466,7 +466,7 @@ u8 * ntfs_bmp_get_data(struct ntfs_bmp *bmp, VCN vcn) } /** - * ntfs_bmp_set_range - + * ntfs_bmp_set_range - Set a range of bits in the bitmap * @bmp: * @vcn: * @length: @@ -563,7 +563,7 @@ int ntfs_bmp_set_range(struct ntfs_bmp *bmp, VCN vcn, s64 length, int value) } /** - * ntfs_bmp_find_last_set - + * ntfs_bmp_find_last_set - Find the last set bit in the bitmap * @bmp: * * Description... @@ -632,7 +632,7 @@ s64 ntfs_bmp_find_last_set(struct ntfs_bmp *bmp) } /** - * ntfs_bmp_find_space - + * ntfs_bmp_find_space - Find an unused block of bits in a bitmap * @bmp: * @start: * @size: diff --git a/libntfs/collate.c b/libntfs/collate.c index c961efc7..cd365458 100644 --- a/libntfs/collate.c +++ b/libntfs/collate.c @@ -34,7 +34,7 @@ #include "logging.h" /** - * ntfs_collate_binary - + * ntfs_collate_binary - Which of two binary objects should be listed first * @vol: unused * @data1: * @data1_len: @@ -64,7 +64,7 @@ static int ntfs_collate_binary(ntfs_volume *vol __attribute__((unused)), } /** - * ntfs_collate_ntofs_ulong - + * ntfs_collate_ntofs_ulong - Which of two long ints should be listed first * @vol: unused * @data1: * @data1_len: @@ -102,7 +102,7 @@ static int ntfs_collate_ntofs_ulong(ntfs_volume *vol __attribute__((unused)), } /** - * ntfs_collate_file_name - + * ntfs_collate_file_name - Which of two filenames should be listed first * @vol: * @data1: * @data1_len: unused diff --git a/libntfs/compat.c b/libntfs/compat.c index 887b82ff..acdf4db7 100644 --- a/libntfs/compat.c +++ b/libntfs/compat.c @@ -32,7 +32,7 @@ #ifndef HAVE_FFS /** - * ffs - + * ffs - Find the first set bit in an int * @x: * * Description... diff --git a/libntfs/dir.c b/libntfs/dir.c index df6272a0..f79f518a 100644 --- a/libntfs/dir.c +++ b/libntfs/dir.c @@ -1358,7 +1358,7 @@ search: /* * If hard link count is not equal to zero then we are done. In other * case there are no reference to this inode left, so we should free all - * non-resident atributes and mark inode as not in use. + * non-resident attributes and mark inode as not in use. */ if (ni->mrec->link_count) goto out; @@ -1372,13 +1372,13 @@ search: if (!rl) { err = errno; ntfs_log_error("Failed to decompress runlist. " - "Leaving inconsist metadata."); + "Leaving inconsistent metadata."); continue; } if (ntfs_cluster_free_from_rl(ni->vol, rl)) { err = errno; ntfs_log_error("Failed to free clusters. " - "Leaving inconsist metadata."); + "Leaving inconsistent metadata."); continue; } free(rl); @@ -1522,7 +1522,7 @@ err_out: #include "rich.h" /** - * ntfs_dir_rollback - + * ntfs_dir_rollback - Discard the in-memory directory changes * @dir: * * Description... @@ -1554,7 +1554,7 @@ int ntfs_dir_rollback(struct ntfs_dir *dir) } /** - * ntfs_dir_truncate - + * ntfs_dir_truncate - Shrink an index allocation * @vol: * @dir: * @@ -1707,7 +1707,7 @@ int ntfs_dir_truncate(ntfs_volume *vol, struct ntfs_dir *dir) } /** - * ntfs_dir_commit - + * ntfs_dir_commit - Write to disk the in-memory directory changes * @dir: * * Description... @@ -1744,7 +1744,7 @@ int ntfs_dir_commit(struct ntfs_dir *dir) } /** - * ntfs_dir_free - + * ntfs_dir_free - Destroy a directory object * @dir: * * Description... @@ -1789,7 +1789,7 @@ void ntfs_dir_free(struct ntfs_dir *dir) } /** - * ntfs_dir_create - + * ntfs_dir_create - Create a representation of a directory * @vol: * @mft_num: * @@ -1863,7 +1863,7 @@ struct ntfs_dir * ntfs_dir_create(ntfs_volume *vol, MFT_REF mft_num) } /** - * ntfs_dir_add - + * ntfs_dir_add - Add a directory to another as a child * @parent: * @child: * @@ -1890,7 +1890,7 @@ void ntfs_dir_add(struct ntfs_dir *parent, struct ntfs_dir *child) } /** - * ntfs_dir_find2 - + * ntfs_dir_find2 - Find a directory by name * @dir: * @name: * @name_len: diff --git a/libntfs/index.c b/libntfs/index.c index 76250c3d..c31ae7ae 100644 --- a/libntfs/index.c +++ b/libntfs/index.c @@ -662,7 +662,7 @@ err_out: #include "rich.h" /** - * ntfs_ie_free - + * ntfs_ie_free - Destroy an index entry object * @ie: * * Description... @@ -676,7 +676,7 @@ void ntfs_ie_free(INDEX_ENTRY *ie) } /** - * ntfs_ie_create - + * ntfs_ie_create - Create a representation of an directory index entry * * Description... * @@ -702,7 +702,7 @@ INDEX_ENTRY * ntfs_ie_create(void) } /** - * ntfs_ie_get_vcn - + * ntfs_ie_get_vcn - Get the VCN associated with an index entry * @ie: * * Description... @@ -721,7 +721,7 @@ VCN ntfs_ie_get_vcn(INDEX_ENTRY *ie) } /** - * ntfs_ie_copy - + * ntfs_ie_copy - Create a copy of an index entry * @ie: * * Description... @@ -745,7 +745,7 @@ INDEX_ENTRY * ntfs_ie_copy(INDEX_ENTRY *ie) } /** - * ntfs_ie_set_vcn - + * ntfs_ie_set_vcn - Set VCN associated with an index entry * @ie: * @vcn: * @@ -773,7 +773,7 @@ INDEX_ENTRY * ntfs_ie_set_vcn(INDEX_ENTRY *ie, VCN vcn) } /** - * ntfs_ie_remove_vcn - + * ntfs_ie_remove_vcn - Remove the VCN associated with an index entry * @ie: * * Description... @@ -795,7 +795,7 @@ INDEX_ENTRY * ntfs_ie_remove_vcn(INDEX_ENTRY *ie) } /** - * ntfs_ie_set_name - + * ntfs_ie_set_name - Associate a name with an index entry * @ie: * @name: * @namelen: @@ -891,7 +891,7 @@ INDEX_ENTRY * ntfs_ie_set_name(INDEX_ENTRY *ie, ntfschar *name, int namelen, FIL } /** - * ntfs_ie_remove_name - + * ntfs_ie_remove_name - Remove the name from an index-entry * @ie: * * Description... diff --git a/libntfs/inode.c b/libntfs/inode.c index 9e876e1e..b6291bba 100644 --- a/libntfs/inode.c +++ b/libntfs/inode.c @@ -50,7 +50,7 @@ #include "logging.h" /** - * __ntfs_inode_allocate - + * __ntfs_inode_allocate - Create and initialise an NTFS inode object * @vol: * * Description... @@ -68,7 +68,7 @@ static __inline__ ntfs_inode *__ntfs_inode_allocate(ntfs_volume *vol) } /** - * ntfs_inode_allocate - + * ntfs_inode_allocate - Create an NTFS inode object * @vol: * * Description... @@ -81,7 +81,7 @@ ntfs_inode *ntfs_inode_allocate(ntfs_volume *vol) } /** - * __ntfs_inode_release - + * __ntfs_inode_release - Destroy an NTFS inode object * @ni: * * Description... @@ -1073,7 +1073,7 @@ put_err_out: #include "rich.h" /** - * ntfs_inode_close2 - + * ntfs_inode_close2 - Close an inode, freeing any resources * @ni: * * Description... @@ -1101,7 +1101,7 @@ int ntfs_inode_close2(ntfs_inode *ni) } /** - * ntfs_inode_open2 - + * ntfs_inode_open2 - Open an inode and initialise it * @vol: * @mref: * @@ -1156,7 +1156,7 @@ ntfs_inode * ntfs_inode_open2(ntfs_volume *vol, const MFT_REF mref) } /** - * ntfs_inode_open3 - + * ntfs_inode_open3 - Open an inode and initialise it * @vol: * @mref: * diff --git a/libntfs/mft.c b/libntfs/mft.c index 43dca2d0..d33fb91e 100644 --- a/libntfs/mft.c +++ b/libntfs/mft.c @@ -392,7 +392,7 @@ static const char *es = " Leaving inconsistent metadata. Run chkdsk."; #endif /** - * ntfs_ffz - + * ntfs_ffz - Find the first unset (zero) bit in a word * @word: * * Description... @@ -1566,7 +1566,7 @@ sync_rollback: #include "rich.h" /** - * ntfs_mft_remove_attr - + * ntfs_mft_remove_attr - Remove an attribute from an MFT record * @bmp: * @inode: * @type: @@ -1632,7 +1632,7 @@ int ntfs_mft_remove_attr(struct ntfs_bmp *bmp, ntfs_inode *inode, ATTR_TYPES typ } /** - * ntfs_mft_add_attr - + * ntfs_mft_add_attr - Add an attribute to an MFT record * @inode: * @type: * @data: @@ -1710,7 +1710,7 @@ ATTR_RECORD * ntfs_mft_add_attr(ntfs_inode *inode, ATTR_TYPES type, u8 *data, in } /** - * ntfs_mft_resize_resident - + * ntfs_mft_resize_resident - Resize a resident attribute in an MFT record * @inode: * @type: * @name: @@ -1819,7 +1819,7 @@ done: } /** - * ntfs_mft_free_space - + * ntfs_mft_free_space - Calculate the free space (bytes) in an MFT record * @dir: * * Description... @@ -1843,7 +1843,7 @@ int ntfs_mft_free_space(struct ntfs_dir *dir) } /** - * ntfs_mft_add_index - + * ntfs_mft_add_index - Add an index (directory) to an MFT record * @dir: * * Description... diff --git a/libntfs/rich.c b/libntfs/rich.c index bd3d4024..1921e9dc 100644 --- a/libntfs/rich.c +++ b/libntfs/rich.c @@ -112,7 +112,7 @@ ATTR_RECORD * find_first_attribute(const ATTR_TYPES type, MFT_RECORD *mft) } /** - * ntfs_name_print - + * ntfs_name_print - Send a Unicode name to the debug log * @name: * @name_len: * @@ -134,7 +134,7 @@ void ntfs_name_print(ntfschar *name, int name_len) } /** - * utils_free_non_residents3 - + * utils_free_non_residents3 - Free all the non-resident attributes of an inode * @bmp: * @inode: * @attr: @@ -178,7 +178,7 @@ int utils_free_non_residents3(struct ntfs_bmp *bmp, ntfs_inode *inode, ATTR_RECO } /** - * utils_free_non_residents2 - + * utils_free_non_residents2 - Find all the non-resident attributes of an inode * @inode: * @bmp: * diff --git a/libntfs/runlist.c b/libntfs/runlist.c index b055450b..22f46a1d 100644 --- a/libntfs/runlist.c +++ b/libntfs/runlist.c @@ -1718,7 +1718,7 @@ s64 ntfs_rl_get_compressed_size(ntfs_volume *vol, runlist *rl) } */ /** - * test_rl_dump_runlist - + * test_rl_dump_runlist - Runlist test: Display the contents of a runlist * @rl: * * Description... @@ -1770,7 +1770,7 @@ static void test_rl_dump_runlist(const runlist_element *rl) } /** - * test_rl_runlists_merge - + * test_rl_runlists_merge - Runlist test: Merge two runlists * @drl: * @srl: * @@ -1796,7 +1796,7 @@ static runlist_element * test_rl_runlists_merge(runlist_element *drl, runlist_el } /** - * test_rl_read_buffer - + * test_rl_read_buffer - Runlist test: Read a file containing a runlist * @file: * @buf: * @bufsize: @@ -1825,7 +1825,7 @@ static int test_rl_read_buffer(const char *file, u8 *buf, int bufsize) } /** - * test_rl_pure_src - + * test_rl_pure_src - Runlist test: Complicate the simple tests a little * @contig: * @multi: * @vcn: @@ -1860,7 +1860,7 @@ static runlist_element * test_rl_pure_src(BOOL contig, BOOL multi, int vcn, int } /** - * test_rl_pure_test - + * test_rl_pure_test - Runlist test: Perform tests using simple runlists * @test: * @contig: * @multi: @@ -1891,7 +1891,7 @@ static void test_rl_pure_test(int test, BOOL contig, BOOL multi, int vcn, int le } /** - * test_rl_pure - + * test_rl_pure - Runlist test: Create tests using simple runlists * @contig: * @multi: * @@ -1991,7 +1991,7 @@ static void test_rl_pure(char *contig, char *multi) } /** - * test_rl_zero - + * test_rl_zero - Runlist test: Merge a zero-length runlist * * Description... * @@ -2017,7 +2017,7 @@ static void test_rl_zero(void) } /** - * test_rl_frag_combine - + * test_rl_frag_combine - Runlist test: Perform tests using fragmented files * @vol: * @attr1: * @attr2: @@ -2053,7 +2053,7 @@ static void test_rl_frag_combine(ntfs_volume *vol, ATTR_RECORD *attr1, ATTR_RECO } /** - * test_rl_frag - + * test_rl_frag - Runlist test: Create tests using very fragmented files * @test: * * Description... @@ -2098,7 +2098,7 @@ out: } /** - * test_rl_main - + * test_rl_main - Runlist test: Program start (main) * @argc: * @argv: * diff --git a/libntfs/tree.c b/libntfs/tree.c index c7733587..9cb2d382 100644 --- a/libntfs/tree.c +++ b/libntfs/tree.c @@ -42,7 +42,7 @@ #include "rich.h" /** - * ntfs_dt_free - + * ntfs_dt_free - Destroy a directory-tree object * @dt: * * Description... @@ -71,7 +71,7 @@ void ntfs_dt_free(struct ntfs_dt *dt) } /** - * ntfs_dt_rollback - + * ntfs_dt_rollback - Discard the in-memory directory-tree changes * @dt: * * Description... @@ -123,7 +123,7 @@ int ntfs_dt_rollback(struct ntfs_dt *dt) } /** - * ntfs_dt_commit - + * ntfs_dt_commit - Write to disk the in-memory directory-tree changes * @dt: * * Description... @@ -186,7 +186,7 @@ int ntfs_dt_commit(struct ntfs_dt *dt) } /** - * ntfs_dt_create_children2 - + * ntfs_dt_create_children2 - Allocate space for the directory-tree's children * @dt: * @count: * @@ -220,7 +220,7 @@ BOOL ntfs_dt_create_children2(struct ntfs_dt *dt, int count) } /** - * ntfs_dt_resize_children3 - + * ntfs_dt_resize_children3 - Resize a directory-tree's children arrays * @dt: * @new: * @@ -266,7 +266,7 @@ BOOL ntfs_dt_resize_children3(struct ntfs_dt *dt, int new) } /** - * ntfs_dt_root_count - + * ntfs_dt_root_count - Count the index entries in an index root * @dt: * * Description... @@ -334,7 +334,7 @@ int ntfs_dt_root_count(struct ntfs_dt *dt) } /** - * ntfs_dt_alloc_count - + * ntfs_dt_alloc_count - Count the index entries in an index allocation * @dt: * * Description... @@ -398,7 +398,7 @@ int ntfs_dt_alloc_count(struct ntfs_dt *dt) } /** - * ntfs_dt_initialise2 - + * ntfs_dt_initialise2 - Setup a directory-tree object * @vol: * @dt: * @@ -447,7 +447,7 @@ int ntfs_dt_initialise2(ntfs_volume *vol, struct ntfs_dt *dt) } /** - * ntfs_dt_create - + * ntfs_dt_create - Create a representation of a directory index * @dir: * @parent: * @vcn: @@ -554,7 +554,7 @@ struct ntfs_dt * ntfs_dt_create(struct ntfs_dir *dir, struct ntfs_dt *parent, VC } /** - * ntfs_dt_find - + * ntfs_dt_find - Find an index entry by name * @dt: * @name: * @name_len: @@ -634,7 +634,7 @@ MFT_REF ntfs_dt_find(struct ntfs_dt *dt, ntfschar *name, int name_len) } /** - * ntfs_dt_find2 - + * ntfs_dt_find2 - Find an index entry by name * @dt: * @name: * @name_len: @@ -718,7 +718,7 @@ struct ntfs_dt * ntfs_dt_find2(struct ntfs_dt *dt, ntfschar *name, int name_len, } /** - * ntfs_dt_find3 - + * ntfs_dt_find3 - Find an index entry by name * @dt: * @name: * @name_len: @@ -784,7 +784,7 @@ struct ntfs_dt * ntfs_dt_find3(struct ntfs_dt *dt, ntfschar *name, int name_len, } /** - * ntfs_dt_find4 - + * ntfs_dt_find4 - Find an index entry by name * @dt: * @name: * @name_len: @@ -858,7 +858,7 @@ struct ntfs_dt * ntfs_dt_find4(struct ntfs_dt *dt, ntfschar *name, int name_len, } /** - * ntfs_dt_find_all - + * ntfs_dt_find_all - Recurse the directory-tree, mapping all elements * @dt: * * maps all dt's into memory @@ -887,7 +887,7 @@ void ntfs_dt_find_all(struct ntfs_dt *dt) } /** - * ntfs_dt_find_parent - + * ntfs_dt_find_parent - Find the index of ourself in the parent's array * @dt: * * Description... @@ -915,7 +915,7 @@ int ntfs_dt_find_parent(struct ntfs_dt *dt) } /** - * ntfs_dt_isroot - + * ntfs_dt_isroot - Does this directory-tree represent an index root * @dt: * * Description... @@ -931,7 +931,7 @@ BOOL ntfs_dt_isroot(struct ntfs_dt *dt) } /** - * ntfs_dt_root_freespace - + * ntfs_dt_root_freespace - Give the free space (bytes) in an index root * @dt: * * Description... @@ -957,7 +957,7 @@ int ntfs_dt_root_freespace(struct ntfs_dt *dt) } /** - * ntfs_dt_alloc_freespace - + * ntfs_dt_alloc_freespace - Give the free space (bytes) in an index allocation * @dt: * * Description... @@ -983,7 +983,7 @@ int ntfs_dt_alloc_freespace(struct ntfs_dt *dt) } /** - * ntfs_dt_transfer - + * ntfs_dt_transfer - Transfer several index entries between directory-trees * @old: * @new: * @start: @@ -1141,7 +1141,7 @@ int ntfs_dt_transfer(struct ntfs_dt *old, struct ntfs_dt *new, int start, int co } /** - * ntfs_dt_alloc_insert - + * ntfs_dt_alloc_insert - Insert an index entry into an index allocation * @dt: * @first: * @count: @@ -1212,7 +1212,7 @@ int ntfs_dt_alloc_insert(struct ntfs_dt *dt, INDEX_ENTRY *first, int count) } /** - * ntfs_dt_alloc_insert2 - + * ntfs_dt_alloc_insert2 - Insert an index entry into an index allocation * @dt: * @before: * @count: @@ -1287,7 +1287,7 @@ INDEX_ENTRY * ntfs_dt_alloc_insert2(struct ntfs_dt *dt, int before, int count, i } /** - * ntfs_dt_root_insert - + * ntfs_dt_root_insert - Insert an index entry into an index root * @dt: * @first: * @count: @@ -1308,7 +1308,7 @@ int ntfs_dt_root_insert(struct ntfs_dt *dt, INDEX_ENTRY *first, int count) } /** - * ntfs_dt_alloc_remove2 - + * ntfs_dt_alloc_remove2 - Remove an index entry from an index allocation * @dt: * @start: * @count: @@ -1335,7 +1335,7 @@ int ntfs_dt_alloc_remove2(struct ntfs_dt *dt, int start, int count) } /** - * ntfs_dt_root_remove2 - + * ntfs_dt_root_remove2 - Remove an index entry from an index root * @dt: * @start: * @count: @@ -1384,7 +1384,7 @@ int ntfs_dt_root_remove2(struct ntfs_dt *dt, int start, int count) } /** - * ntfs_dt_transfer2 - + * ntfs_dt_transfer2 - Transfer several index entries between directory-trees * @old: * @new: * @start: @@ -1553,7 +1553,7 @@ int ntfs_dt_transfer2(struct ntfs_dt *old, struct ntfs_dt *new, int start, int c } /** - * ntfs_dt_root_replace - + * ntfs_dt_root_replace - Replace an index entry in an index root * @del: * @del_num: * @del_ie: @@ -1641,7 +1641,7 @@ int ntfs_dt_root_replace(struct ntfs_dt *del, int del_num, INDEX_ENTRY *del_ie, } /** - * ntfs_dt_alloc_replace - + * ntfs_dt_alloc_replace - Replace an index entry in an index allocation * @del: * @del_num: * @del_ie: @@ -1712,7 +1712,7 @@ BOOL ntfs_dt_alloc_replace(struct ntfs_dt *del, int del_num, INDEX_ENTRY *del_ie } /** - * ntfs_dt_root_remove - + * ntfs_dt_root_remove - Remove an index entry from an index root * @del: * @del_num: * @@ -1840,7 +1840,7 @@ BOOL ntfs_dt_root_remove(struct ntfs_dt *del, int del_num) } /** - * ntfs_dt_alloc_remove - + * ntfs_dt_alloc_remove - Remove an index entry from an index allocation * @del: * @del_num: * @@ -1969,7 +1969,7 @@ BOOL ntfs_dt_alloc_remove(struct ntfs_dt *del, int del_num) } /** - * ntfs_dt_alloc_add - + * ntfs_dt_alloc_add - Add an index entry to an index allocation * @parent: * @index_num: * @ie: @@ -2066,7 +2066,7 @@ int ntfs_dt_alloc_add(struct ntfs_dt *parent, int index_num, INDEX_ENTRY *ie, st } /** - * ntfs_dt_root_add - + * ntfs_dt_root_add - Add an index entry to an index root * @parent: * @index_num: * @ie: @@ -2177,7 +2177,7 @@ int ntfs_dt_root_add(struct ntfs_dt *parent, int index_num, INDEX_ENTRY *ie, str } /** - * ntfs_dt_add2 - + * ntfs_dt_add2 - Add an index entry to a directory-tree * @ie: * @suc: * @suc_num: diff --git a/libntfs/unistr.c b/libntfs/unistr.c index f34355ff..ed4adf80 100644 --- a/libntfs/unistr.c +++ b/libntfs/unistr.c @@ -307,7 +307,7 @@ ntfschar *ntfs_ucsndup(const ntfschar *s, u32 maxlen) } /** - * ntfs_name_upcase - + * ntfs_name_upcase - Map an Unicode name to its uppercase equivalent * @name: * @name_len: * @upcase: @@ -329,7 +329,7 @@ void ntfs_name_upcase(ntfschar *name, u32 name_len, const ntfschar *upcase, } /** - * ntfs_file_value_upcase - + * ntfs_file_value_upcase - Convert a filename to upper case * @file_name_attr: * @upcase: * @upcase_len: @@ -346,7 +346,7 @@ void ntfs_file_value_upcase(FILE_NAME_ATTR *file_name_attr, } /** - * ntfs_file_values_compare - + * ntfs_file_values_compare - Which of two filenames should be listed first * @file_name_attr1: * @file_name_attr2: * @err_val: diff --git a/libntfs/unix_io.c b/libntfs/unix_io.c index 8cc94c1f..9ee5f3de 100644 --- a/libntfs/unix_io.c +++ b/libntfs/unix_io.c @@ -67,7 +67,7 @@ #define DEV_FD(dev) (*(int *)dev->d_private) /** - * ntfs_device_unix_io_open - + * ntfs_device_unix_io_open - Open a device and lock it exclusively * @dev: * @flags: * @@ -122,7 +122,7 @@ err_out: } /** - * ntfs_device_unix_io_close - + * ntfs_device_unix_io_close - Close the device, releasing the lock * @dev: * * Description... @@ -157,7 +157,7 @@ static int ntfs_device_unix_io_close(struct ntfs_device *dev) } /** - * ntfs_device_unix_io_seek - + * ntfs_device_unix_io_seek - Seek to a place on the device * @dev: * @offset: * @whence: @@ -173,7 +173,7 @@ static s64 ntfs_device_unix_io_seek(struct ntfs_device *dev, s64 offset, } /** - * ntfs_device_unix_io_read - + * ntfs_device_unix_io_read - Read from the device, from the current location * @dev: * @buf: * @count: @@ -189,7 +189,7 @@ static s64 ntfs_device_unix_io_read(struct ntfs_device *dev, void *buf, } /** - * ntfs_device_unix_io_write - + * ntfs_device_unix_io_write - Write to the device, at the current location * @dev: * @buf: * @count: @@ -210,7 +210,7 @@ static s64 ntfs_device_unix_io_write(struct ntfs_device *dev, const void *buf, } /** - * ntfs_device_unix_io_pread - + * ntfs_device_unix_io_pread - Perform a positioned read from the device * @dev: * @buf: * @count: @@ -227,7 +227,7 @@ static s64 ntfs_device_unix_io_pread(struct ntfs_device *dev, void *buf, } /** - * ntfs_device_unix_io_pwrite - + * ntfs_device_unix_io_pwrite - Perform a positioned write to the device * @dev: * @buf: * @count: @@ -249,7 +249,7 @@ static s64 ntfs_device_unix_io_pwrite(struct ntfs_device *dev, const void *buf, } /** - * ntfs_device_unix_io_sync - + * ntfs_device_unix_io_sync - Flush any buffered changes to the device * @dev: * * Description... @@ -268,7 +268,7 @@ static int ntfs_device_unix_io_sync(struct ntfs_device *dev) } /** - * ntfs_device_unix_io_stat - + * ntfs_device_unix_io_stat - Get information about the device * @dev: * @buf: * @@ -282,7 +282,7 @@ static int ntfs_device_unix_io_stat(struct ntfs_device *dev, struct stat *buf) } /** - * ntfs_device_unix_io_ioctl - + * ntfs_device_unix_io_ioctl - Perform an ioctl on the device * @dev: * @request: * @argp: diff --git a/libntfs/volume.c b/libntfs/volume.c index 598ae14e..b8285d4d 100644 --- a/libntfs/volume.c +++ b/libntfs/volume.c @@ -67,7 +67,7 @@ #endif /** - * ntfs_volume_alloc - + * ntfs_volume_alloc - Create an NTFS volume object and initialise it * * Description... * @@ -95,7 +95,7 @@ ntfs_volume *ntfs_volume_alloc(void) } /** - * __ntfs_volume_release - + * __ntfs_volume_release - Destroy an NTFS volume object * @v: * * Description... @@ -1606,7 +1606,7 @@ int utils_valid_device(const char *name, int force) } /** - * utils_mount_volume - + * utils_mount_volume - Mount an NTFS volume * @device: * @flags: * @force: @@ -1660,7 +1660,7 @@ ntfs_volume * utils_mount_volume(const char *device, unsigned long flags, BOOL f } /** - * ntfs_volume_commit - + * ntfs_volume_commit - Write to disk the in-memory volume changes * @vol: * * Description... @@ -1687,7 +1687,7 @@ int ntfs_volume_commit(ntfs_volume *vol) } /** - * ntfs_volume_rollback - + * ntfs_volume_rollback - Discard the in-memory volume changes * @vol: * * Description... @@ -1713,7 +1713,7 @@ int ntfs_volume_rollback(ntfs_volume *vol) } /** - * ntfs_volume_umount2 - + * ntfs_volume_umount2 - Unmount an NTFS volume, using the new directory support * @vol: * @force: * @@ -1748,7 +1748,7 @@ int ntfs_volume_umount2(ntfs_volume *vol, const BOOL force) } /** - * ntfs_volume_mount2 - + * ntfs_volume_mount2 - Mount an NTFS volume, using the new directory support * @device: * @flags: * @force: diff --git a/ntfsprogs/utils.c b/ntfsprogs/utils.c index cc9d0fa2..dbf6c276 100644 --- a/ntfsprogs/utils.c +++ b/ntfsprogs/utils.c @@ -165,7 +165,7 @@ int utils_valid_device(const char *name, int force) } /** - * utils_mount_volume + * utils_mount_volume - Mount an NTFS volume */ ntfs_volume * utils_mount_volume(const char *device, unsigned long flags, BOOL force) {