diff --git a/libntfs/attrib.c b/libntfs/attrib.c index cf1a61d3..5465118e 100644 --- a/libntfs/attrib.c +++ b/libntfs/attrib.c @@ -59,7 +59,12 @@ ntfschar AT_UNNAMED[] = { const_cpu_to_le16('\0') }; /** - * ntfs_get_attribute_value_length + * ntfs_get_attribute_value_length - + * @a: + * + * Description... + * + * Returns: */ s64 ntfs_get_attribute_value_length(const ATTR_RECORD *a) { @@ -77,7 +82,14 @@ s64 ntfs_get_attribute_value_length(const ATTR_RECORD *a) } /** - * ntfs_get_attribute_value + * ntfs_get_attribute_value - + * @vol: + * @a: + * @b: + * + * Description... + * + * Returns: */ s64 ntfs_get_attribute_value(const ntfs_volume *vol, const ATTR_RECORD *a, u8 *b) @@ -245,8 +257,6 @@ s64 ntfs_get_attribute_value(const ntfs_volume *vol, /* Already cleaned up code below, but still look for FIXME:... */ /** - * Internal: - * * __ntfs_attr_init - primary initialization of an ntfs attribute structure * @na: ntfs attribute to initialize * @ni: ntfs inode with which to initialize the ntfs attribute @@ -1476,8 +1486,6 @@ s64 ntfs_attr_mst_pwrite(ntfs_attr *na, const s64 pos, s64 bk_cnt, } /** - * Internal: - * * ntfs_attr_find - find (next) attribute in mft record * @type: attribute type to find * @name: attribute name to find (optional, i.e. NULL means don't care) @@ -1680,8 +1688,6 @@ static int ntfs_attr_find(const ATTR_TYPES type, const ntfschar *name, } /** - * Internal: - * * ntfs_external_attr_find - find an attribute in the attribute list of an inode * @type: attribute type to find * @name: attribute name to find (optional, i.e. NULL means don't care) @@ -2189,8 +2195,6 @@ int ntfs_attr_lookup(const ATTR_TYPES type, const ntfschar *name, } /** - * Internal: - * * ntfs_attr_init_search_ctx - initialize an attribute search context * @ctx: attribute search context to initialize * @ni: ntfs inode with which to initialize the search context diff --git a/libntfs/bitmap.c b/libntfs/bitmap.c index 5532c3ec..495f2bb6 100644 --- a/libntfs/bitmap.c +++ b/libntfs/bitmap.c @@ -228,7 +228,12 @@ int ntfs_bitmap_clear_run(ntfs_attr *na, s64 start_bit, s64 count) #include "rich.h" /** - * ntfs_bmp_rollback + * ntfs_bmp_rollback - + * @bmp: + * + * Description... + * + * Returns: */ int ntfs_bmp_rollback(struct ntfs_bmp *bmp) { @@ -252,7 +257,12 @@ int ntfs_bmp_rollback(struct ntfs_bmp *bmp) } /** - * ntfs_bmp_commit + * ntfs_bmp_commit - + * @bmp: + * + * Description... + * + * Returns: */ int ntfs_bmp_commit(struct ntfs_bmp *bmp) { @@ -301,7 +311,12 @@ int ntfs_bmp_commit(struct ntfs_bmp *bmp) } /** - * ntfs_bmp_free + * ntfs_bmp_free - + * @bmp: + * + * Description... + * + * Returns: */ void ntfs_bmp_free(struct ntfs_bmp *bmp) { @@ -317,7 +332,15 @@ void ntfs_bmp_free(struct ntfs_bmp *bmp) } /** - * ntfs_bmp_create + * ntfs_bmp_create - + * @inode: + * @type: + * @name: + * @name_len: + * + * Description... + * + * Returns: */ struct ntfs_bmp * ntfs_bmp_create(ntfs_inode *inode, ATTR_TYPES type, ntfschar *name, int name_len) { @@ -349,7 +372,14 @@ struct ntfs_bmp * ntfs_bmp_create(ntfs_inode *inode, ATTR_TYPES type, ntfschar * } /** - * ntfs_bmp_add_data + * ntfs_bmp_add_data - + * @bmp: + * @vcn: + * @data: + * + * Description... + * + * Returns: */ int ntfs_bmp_add_data(struct ntfs_bmp *bmp, VCN vcn, u8 *data) { @@ -386,7 +416,13 @@ int ntfs_bmp_add_data(struct ntfs_bmp *bmp, VCN vcn, u8 *data) } /** - * ntfs_bmp_get_data + * ntfs_bmp_get_data - + * @bmp: + * @vcn: + * + * Description... + * + * Returns: */ u8 * ntfs_bmp_get_data(struct ntfs_bmp *bmp, VCN vcn) { @@ -430,7 +466,15 @@ u8 * ntfs_bmp_get_data(struct ntfs_bmp *bmp, VCN vcn) } /** - * ntfs_bmp_set_range + * ntfs_bmp_set_range - + * @bmp: + * @vcn: + * @length: + * @value: + * + * Description... + * + * Returns: */ int ntfs_bmp_set_range(struct ntfs_bmp *bmp, VCN vcn, s64 length, int value) { @@ -519,7 +563,12 @@ 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 - + * @bmp: + * + * Description... + * + * Returns: */ s64 ntfs_bmp_find_last_set(struct ntfs_bmp *bmp) { @@ -583,7 +632,14 @@ s64 ntfs_bmp_find_last_set(struct ntfs_bmp *bmp) } /** - * ntfs_bmp_find_space + * ntfs_bmp_find_space - + * @bmp: + * @start: + * @size: + * + * Description... + * + * Returns: */ int ntfs_bmp_find_space(struct ntfs_bmp *bmp, LCN start, long size) { diff --git a/libntfs/collate.c b/libntfs/collate.c index 7bc354a2..c961efc7 100644 --- a/libntfs/collate.c +++ b/libntfs/collate.c @@ -34,7 +34,16 @@ #include "logging.h" /** - * ntfs_collate_binary + * ntfs_collate_binary - + * @vol: unused + * @data1: + * @data1_len: + * @data2: + * @data2_len: + * + * Description... + * + * Returns: */ static int ntfs_collate_binary(ntfs_volume *vol __attribute__((unused)), const void *data1, const int data1_len, @@ -55,7 +64,16 @@ static int ntfs_collate_binary(ntfs_volume *vol __attribute__((unused)), } /** - * ntfs_collate_ntofs_ulong + * ntfs_collate_ntofs_ulong - + * @vol: unused + * @data1: + * @data1_len: + * @data2: + * @data2_len: + * + * Description... + * + * Returns: */ static int ntfs_collate_ntofs_ulong(ntfs_volume *vol __attribute__((unused)), const void *data1, const int data1_len, @@ -84,7 +102,16 @@ static int ntfs_collate_ntofs_ulong(ntfs_volume *vol __attribute__((unused)), } /** - * ntfs_collate_file_name + * ntfs_collate_file_name - + * @vol: + * @data1: + * @data1_len: unused + * @data2: + * @data2_len: unused + * + * Description... + * + * Returns: */ static int ntfs_collate_file_name(ntfs_volume *vol, const void *data1, const int data1_len __attribute__((unused)), diff --git a/libntfs/compat.c b/libntfs/compat.c index 636987d5..887b82ff 100644 --- a/libntfs/compat.c +++ b/libntfs/compat.c @@ -28,8 +28,17 @@ #include "compat.h" -// TODO: Add check for FFS in the configure script... (AIA) +/* TODO: Add check for FFS in the configure script... (AIA) */ + #ifndef HAVE_FFS +/** + * ffs - + * @x: + * + * Description... + * + * Returns: + */ int ffs(int x) { int r = 1; diff --git a/libntfs/debug.c b/libntfs/debug.c index 63eabbb1..c4443023 100644 --- a/libntfs/debug.c +++ b/libntfs/debug.c @@ -35,6 +35,11 @@ #ifndef NTFS_DISABLE_DEBUG_LOGGING /** * ntfs_debug_runlist_dump - Dump a runlist. + * @rl: + * + * Description... + * + * Returns: */ void ntfs_debug_runlist_dump(const runlist_element *rl) { diff --git a/libntfs/dir.c b/libntfs/dir.c index 4b1ab17d..170583e8 100644 --- a/libntfs/dir.c +++ b/libntfs/dir.c @@ -603,8 +603,6 @@ typedef enum { } INDEX_TYPE; /** - * Internal: - * * ntfs_filldir - ntfs specific filldir method * @dir_ni: ntfs inode of current directory * @pos: current position in directory @@ -646,8 +644,6 @@ static inline int ntfs_filldir(ntfs_inode *dir_ni, s64 *pos, u8 ivcn_bits, } /** - * Internal: - * * ntfs_mft_get_parent_ref - find mft reference of parent directory of an inode * @ni: ntfs inode whose parent directory to find * @@ -1519,7 +1515,12 @@ err_out: #include "rich.h" /** - * ntfs_dir_rollback + * ntfs_dir_rollback - + * @dir: + * + * Description... + * + * Returns: */ int ntfs_dir_rollback(struct ntfs_dir *dir) { @@ -1546,7 +1547,13 @@ int ntfs_dir_rollback(struct ntfs_dir *dir) } /** - * ntfs_dir_truncate + * ntfs_dir_truncate - + * @vol: + * @dir: + * + * Description... + * + * Returns: */ int ntfs_dir_truncate(ntfs_volume *vol, struct ntfs_dir *dir) { @@ -1693,7 +1700,12 @@ int ntfs_dir_truncate(ntfs_volume *vol, struct ntfs_dir *dir) } /** - * ntfs_dir_commit + * ntfs_dir_commit - + * @dir: + * + * Description... + * + * Returns: */ int ntfs_dir_commit(struct ntfs_dir *dir) { @@ -1725,7 +1737,12 @@ int ntfs_dir_commit(struct ntfs_dir *dir) } /** - * ntfs_dir_free + * ntfs_dir_free - + * @dir: + * + * Description... + * + * Returns: */ void ntfs_dir_free(struct ntfs_dir *dir) { @@ -1765,7 +1782,13 @@ void ntfs_dir_free(struct ntfs_dir *dir) } /** - * ntfs_dir_create + * ntfs_dir_create - + * @vol: + * @mft_num: + * + * Description... + * + * Returns: */ struct ntfs_dir * ntfs_dir_create(ntfs_volume *vol, MFT_REF mft_num) { @@ -1833,7 +1856,13 @@ struct ntfs_dir * ntfs_dir_create(ntfs_volume *vol, MFT_REF mft_num) } /** - * ntfs_dir_add + * ntfs_dir_add - + * @parent: + * @child: + * + * Description... + * + * Returns: */ void ntfs_dir_add(struct ntfs_dir *parent, struct ntfs_dir *child) { @@ -1854,7 +1883,14 @@ void ntfs_dir_add(struct ntfs_dir *parent, struct ntfs_dir *child) } /** - * ntfs_dir_find2 + * ntfs_dir_find2 - + * @dir: + * @name: + * @name_len: + * + * Description... + * + * Returns: */ struct ntfs_dir * ntfs_dir_find2(struct ntfs_dir *dir, ntfschar *name, int name_len) { diff --git a/libntfs/index.c b/libntfs/index.c index 2c0330d5..76250c3d 100644 --- a/libntfs/index.c +++ b/libntfs/index.c @@ -662,7 +662,12 @@ err_out: #include "rich.h" /** - * ntfs_ie_free + * ntfs_ie_free - + * @ie: + * + * Description... + * + * Returns: */ void ntfs_ie_free(INDEX_ENTRY *ie) { @@ -671,7 +676,11 @@ void ntfs_ie_free(INDEX_ENTRY *ie) } /** - * ntfs_ie_create + * ntfs_ie_create - + * + * Description... + * + * Returns: */ INDEX_ENTRY * ntfs_ie_create(void) { @@ -693,7 +702,12 @@ INDEX_ENTRY * ntfs_ie_create(void) } /** - * ntfs_ie_get_vcn + * ntfs_ie_get_vcn - + * @ie: + * + * Description... + * + * Returns: */ VCN ntfs_ie_get_vcn(INDEX_ENTRY *ie) { @@ -707,7 +721,12 @@ VCN ntfs_ie_get_vcn(INDEX_ENTRY *ie) } /** - * ntfs_ie_copy + * ntfs_ie_copy - + * @ie: + * + * Description... + * + * Returns: */ INDEX_ENTRY * ntfs_ie_copy(INDEX_ENTRY *ie) { @@ -726,7 +745,13 @@ INDEX_ENTRY * ntfs_ie_copy(INDEX_ENTRY *ie) } /** - * ntfs_ie_set_vcn + * ntfs_ie_set_vcn - + * @ie: + * @vcn: + * + * Description... + * + * Returns: */ INDEX_ENTRY * ntfs_ie_set_vcn(INDEX_ENTRY *ie, VCN vcn) { @@ -748,7 +773,12 @@ INDEX_ENTRY * ntfs_ie_set_vcn(INDEX_ENTRY *ie, VCN vcn) } /** - * ntfs_ie_remove_vcn + * ntfs_ie_remove_vcn - + * @ie: + * + * Description... + * + * Returns: */ INDEX_ENTRY * ntfs_ie_remove_vcn(INDEX_ENTRY *ie) { @@ -765,7 +795,15 @@ INDEX_ENTRY * ntfs_ie_remove_vcn(INDEX_ENTRY *ie) } /** - * ntfs_ie_set_name + * ntfs_ie_set_name - + * @ie: + * @name: + * @namelen: + * @nametype: + * + * Description... + * + * Returns: */ INDEX_ENTRY * ntfs_ie_set_name(INDEX_ENTRY *ie, ntfschar *name, int namelen, FILE_NAME_TYPE_FLAGS nametype) { @@ -853,7 +891,12 @@ INDEX_ENTRY * ntfs_ie_set_name(INDEX_ENTRY *ie, ntfschar *name, int namelen, FIL } /** - * ntfs_ie_remove_name + * ntfs_ie_remove_name - + * @ie: + * + * Description... + * + * Returns: */ INDEX_ENTRY * ntfs_ie_remove_name(INDEX_ENTRY *ie) { diff --git a/libntfs/inode.c b/libntfs/inode.c index 22008e9d..9e876e1e 100644 --- a/libntfs/inode.c +++ b/libntfs/inode.c @@ -50,9 +50,12 @@ #include "logging.h" /** - * Internal: + * __ntfs_inode_allocate - + * @vol: * - * __ntfs_inode_allocate - desc + * Description... + * + * Returns: */ static __inline__ ntfs_inode *__ntfs_inode_allocate(ntfs_volume *vol) { @@ -65,9 +68,12 @@ static __inline__ ntfs_inode *__ntfs_inode_allocate(ntfs_volume *vol) } /** - * Internal: + * ntfs_inode_allocate - + * @vol: * - * ntfs_inode_allocate - desc + * Description... + * + * Returns: */ ntfs_inode *ntfs_inode_allocate(ntfs_volume *vol) { @@ -75,9 +81,12 @@ ntfs_inode *ntfs_inode_allocate(ntfs_volume *vol) } /** - * Internal: + * __ntfs_inode_release - + * @ni: * - * __ntfs_inode_release - desc + * Description... + * + * Returns: */ static __inline__ int __ntfs_inode_release(ntfs_inode *ni) { @@ -1064,7 +1073,12 @@ put_err_out: #include "rich.h" /** - * ntfs_inode_close2 + * ntfs_inode_close2 - + * @ni: + * + * Description... + * + * Returns: */ int ntfs_inode_close2(ntfs_inode *ni) { @@ -1087,7 +1101,13 @@ int ntfs_inode_close2(ntfs_inode *ni) } /** - * ntfs_inode_open2 + * ntfs_inode_open2 - + * @vol: + * @mref: + * + * Description... + * + * Returns: */ ntfs_inode * ntfs_inode_open2(ntfs_volume *vol, const MFT_REF mref) { @@ -1136,8 +1156,13 @@ ntfs_inode * ntfs_inode_open2(ntfs_volume *vol, const MFT_REF mref) } /** - * ntfs_inode_open3 - * open a deleted inode + * ntfs_inode_open3 - + * @vol: + * @mref: + * + * Description... + * + * Returns: */ ntfs_inode * ntfs_inode_open3(ntfs_volume *vol, const MFT_REF mref) { diff --git a/libntfs/mft.c b/libntfs/mft.c index 3a2f72a8..43dca2d0 100644 --- a/libntfs/mft.c +++ b/libntfs/mft.c @@ -391,6 +391,14 @@ int ntfs_mft_record_format(const ntfs_volume *vol, const MFT_REF mref) static const char *es = " Leaving inconsistent metadata. Run chkdsk."; #endif +/** + * ntfs_ffz - + * @word: + * + * Description... + * + * Returns: + */ static inline unsigned int ntfs_ffz(unsigned int word) { return ffs(~word) - 1; @@ -1558,7 +1566,14 @@ sync_rollback: #include "rich.h" /** - * ntfs_mft_remove_attr + * ntfs_mft_remove_attr - + * @bmp: + * @inode: + * @type: + * + * Description... + * + * Returns: */ int ntfs_mft_remove_attr(struct ntfs_bmp *bmp, ntfs_inode *inode, ATTR_TYPES type) { @@ -1617,7 +1632,15 @@ int ntfs_mft_remove_attr(struct ntfs_bmp *bmp, ntfs_inode *inode, ATTR_TYPES typ } /** - * ntfs_mft_add_attr + * ntfs_mft_add_attr - + * @inode: + * @type: + * @data: + * @data_len: + * + * Description... + * + * Returns: */ ATTR_RECORD * ntfs_mft_add_attr(ntfs_inode *inode, ATTR_TYPES type, u8 *data, int data_len) { @@ -1687,7 +1710,17 @@ ATTR_RECORD * ntfs_mft_add_attr(ntfs_inode *inode, ATTR_TYPES type, u8 *data, in } /** - * ntfs_mft_resize_resident + * ntfs_mft_resize_resident - + * @inode: + * @type: + * @name: + * @name_len: + * @data: + * @data_len: + * + * Description... + * + * Returns: */ int ntfs_mft_resize_resident(ntfs_inode *inode, ATTR_TYPES type, ntfschar *name, int name_len, u8 *data, int data_len) { @@ -1786,7 +1819,12 @@ done: } /** - * ntfs_mft_free_space + * ntfs_mft_free_space - + * @dir: + * + * Description... + * + * Returns: */ int ntfs_mft_free_space(struct ntfs_dir *dir) { @@ -1805,7 +1843,12 @@ int ntfs_mft_free_space(struct ntfs_dir *dir) } /** - * ntfs_mft_add_index + * ntfs_mft_add_index - + * @dir: + * + * Description... + * + * Returns: */ int ntfs_mft_add_index(struct ntfs_dir *dir) { diff --git a/libntfs/rich.c b/libntfs/rich.c index cb7ec73c..bd3d4024 100644 --- a/libntfs/rich.c +++ b/libntfs/rich.c @@ -112,7 +112,13 @@ ATTR_RECORD * find_first_attribute(const ATTR_TYPES type, MFT_RECORD *mft) } /** - * ntfs_name_print + * ntfs_name_print - + * @name: + * @name_len: + * + * Description... + * + * Returns: */ void ntfs_name_print(ntfschar *name, int name_len) { @@ -128,7 +134,14 @@ void ntfs_name_print(ntfschar *name, int name_len) } /** - * utils_free_non_residents3 + * utils_free_non_residents3 - + * @bmp: + * @inode: + * @attr: + * + * Description... + * + * Returns: */ int utils_free_non_residents3(struct ntfs_bmp *bmp, ntfs_inode *inode, ATTR_RECORD *attr) { @@ -165,7 +178,13 @@ int utils_free_non_residents3(struct ntfs_bmp *bmp, ntfs_inode *inode, ATTR_RECO } /** - * utils_free_non_residents2 + * utils_free_non_residents2 - + * @inode: + * @bmp: + * + * Description... + * + * Returns: */ int utils_free_non_residents2(ntfs_inode *inode, struct ntfs_bmp *bmp) { diff --git a/libntfs/runlist.c b/libntfs/runlist.c index ac909c65..c5b9d869 100644 --- a/libntfs/runlist.c +++ b/libntfs/runlist.c @@ -47,9 +47,15 @@ #include "logging.h" /** - * Internal: - * * ntfs_rl_mm - runlist memmove + * @base: + * @dst: + * @src: + * @size: + * + * Description... + * + * Returns: */ static __inline__ void ntfs_rl_mm(runlist_element *base, int dst, int src, int size) @@ -59,9 +65,16 @@ static __inline__ void ntfs_rl_mm(runlist_element *base, int dst, int src, } /** - * Internal: - * * ntfs_rl_mc - runlist memory copy + * @dstbase: + * @dst: + * @srcbase: + * @src: + * @size: + * + * Description... + * + * Returns: */ static __inline__ void ntfs_rl_mc(runlist_element *dstbase, int dst, runlist_element *srcbase, int src, int size) @@ -71,8 +84,6 @@ static __inline__ void ntfs_rl_mc(runlist_element *dstbase, int dst, } /** - * Internal: - * * ntfs_rl_realloc - Reallocate memory for runlists * @rl: original runlist * @old_size: number of runlist elements in the original runlist @rl @@ -99,8 +110,6 @@ static __inline__ runlist_element *ntfs_rl_realloc(runlist_element *rl, } /** - * Internal: - * * ntfs_rl_are_mergeable - test if two runlists can be joined together * @dst: original runlist * @src: new runlist to test for mergeability with @dst @@ -138,8 +147,6 @@ static __inline__ BOOL ntfs_rl_are_mergeable(runlist_element *dst, } /** - * Internal: - * * __ntfs_rl_merge - merge two runlists without testing if they can be merged * @dst: original, destination runlist * @src: new runlist to merge with @dst @@ -155,8 +162,6 @@ static __inline__ void __ntfs_rl_merge(runlist_element *dst, } /** - * Internal: - * * ntfs_rl_append - append a runlist after a given element * @dst: original runlist to be worked on * @dsize: number of elements in @dst (including end marker) @@ -224,8 +229,6 @@ static __inline__ runlist_element *ntfs_rl_append(runlist_element *dst, } /** - * Internal: - * * ntfs_rl_insert - insert a runlist into another * @dst: original runlist to be worked on * @dsize: number of elements in @dst (including end marker) @@ -323,8 +326,6 @@ static __inline__ runlist_element *ntfs_rl_insert(runlist_element *dst, } /** - * Internal: - * * ntfs_rl_replace - overwrite a runlist element with another runlist * @dst: original runlist to be worked on * @dsize: number of elements in @dst (including end marker) @@ -407,8 +408,6 @@ static __inline__ runlist_element *ntfs_rl_replace(runlist_element *dst, } /** - * Internal: - * * ntfs_rl_split - insert a runlist into the centre of a hole * @dst: original runlist to be worked on * @dsize: number of elements in @dst (including end marker) @@ -1719,7 +1718,12 @@ s64 ntfs_rl_get_compressed_size(ntfs_volume *vol, runlist *rl) } */ /** - * test_rl_dump_runlist + * test_rl_dump_runlist - + * @rl: + * + * Description... + * + * Returns: */ static void test_rl_dump_runlist(const runlist_element *rl) { @@ -1766,7 +1770,13 @@ static void test_rl_dump_runlist(const runlist_element *rl) } /** - * test_rl_runlists_merge + * test_rl_runlists_merge - + * @drl: + * @srl: + * + * Description... + * + * Returns: */ static runlist_element * test_rl_runlists_merge(runlist_element *drl, runlist_element *srl) { @@ -1786,7 +1796,14 @@ static runlist_element * test_rl_runlists_merge(runlist_element *drl, runlist_el } /** - * test_rl_read_buffer + * test_rl_read_buffer - + * @file: + * @buf: + * @bufsize: + * + * Description... + * + * Returns: */ static int test_rl_read_buffer(const char *file, u8 *buf, int bufsize) { @@ -1808,7 +1825,15 @@ static int test_rl_read_buffer(const char *file, u8 *buf, int bufsize) } /** - * test_rl_pure_src + * test_rl_pure_src - + * @contig: + * @multi: + * @vcn: + * @len: + * + * Description... + * + * Returns: */ static runlist_element * test_rl_pure_src(BOOL contig, BOOL multi, int vcn, int len) { @@ -1835,7 +1860,18 @@ static runlist_element * test_rl_pure_src(BOOL contig, BOOL multi, int vcn, int } /** - * test_rl_pure_test + * test_rl_pure_test - + * @test: + * @contig: + * @multi: + * @vcn: + * @len: + * @file: + * @size: + * + * Description... + * + * Returns: */ static void test_rl_pure_test(int test, BOOL contig, BOOL multi, int vcn, int len, runlist_element *file, int size) { @@ -1855,7 +1891,13 @@ static void test_rl_pure_test(int test, BOOL contig, BOOL multi, int vcn, int le } /** - * test_rl_pure + * test_rl_pure - + * @contig: + * @multi: + * + * Description... + * + * Returns: */ static void test_rl_pure(char *contig, char *multi) { @@ -1949,7 +1991,11 @@ static void test_rl_pure(char *contig, char *multi) } /** - * test_rl_zero + * test_rl_zero - + * + * Description... + * + * Returns: */ static void test_rl_zero(void) { @@ -1971,7 +2017,15 @@ static void test_rl_zero(void) } /** - * test_rl_frag_combine + * test_rl_frag_combine - + * @vol: + * @attr1: + * @attr2: + * @attr3: + * + * Description... + * + * Returns: */ static void test_rl_frag_combine(ntfs_volume *vol, ATTR_RECORD *attr1, ATTR_RECORD *attr2, ATTR_RECORD *attr3) { @@ -1999,7 +2053,12 @@ static void test_rl_frag_combine(ntfs_volume *vol, ATTR_RECORD *attr1, ATTR_RECO } /** - * test_rl_frag + * test_rl_frag - + * @test: + * + * Description... + * + * Returns: */ static void test_rl_frag(char *test) { @@ -2039,7 +2098,13 @@ out: } /** - * test_rl_main + * test_rl_main - + * @argc: + * @argv:[] + * + * Description... + * + * Returns: */ int test_rl_main(int argc, char *argv[]) { diff --git a/libntfs/security.c b/libntfs/security.c index 3e5bfaf8..75aef280 100644 --- a/libntfs/security.c +++ b/libntfs/security.c @@ -258,7 +258,8 @@ err_out: * * Returns: The same pointer it was given as a parameter (guid). */ -GUID *generate_guid(GUID *guid) { +GUID *generate_guid(GUID *guid) +{ int i; static u8 array[16]; diff --git a/libntfs/tree.c b/libntfs/tree.c index 7654e611..c7733587 100644 --- a/libntfs/tree.c +++ b/libntfs/tree.c @@ -42,7 +42,12 @@ #include "rich.h" /** - * ntfs_dt_free + * ntfs_dt_free - + * @dt: + * + * Description... + * + * Returns: */ void ntfs_dt_free(struct ntfs_dt *dt) { @@ -66,7 +71,12 @@ void ntfs_dt_free(struct ntfs_dt *dt) } /** - * ntfs_dt_rollback + * ntfs_dt_rollback - + * @dt: + * + * Description... + * + * Returns: */ int ntfs_dt_rollback(struct ntfs_dt *dt) { @@ -113,7 +123,12 @@ int ntfs_dt_rollback(struct ntfs_dt *dt) } /** - * ntfs_dt_commit + * ntfs_dt_commit - + * @dt: + * + * Description... + * + * Returns: */ int ntfs_dt_commit(struct ntfs_dt *dt) { @@ -171,7 +186,13 @@ int ntfs_dt_commit(struct ntfs_dt *dt) } /** - * ntfs_dt_create_children2 + * ntfs_dt_create_children2 - + * @dt: + * @count: + * + * Description... + * + * Returns: */ BOOL ntfs_dt_create_children2(struct ntfs_dt *dt, int count) { @@ -199,7 +220,13 @@ BOOL ntfs_dt_create_children2(struct ntfs_dt *dt, int count) } /** - * ntfs_dt_resize_children3 + * ntfs_dt_resize_children3 - + * @dt: + * @new: + * + * Description... + * + * Returns: */ BOOL ntfs_dt_resize_children3(struct ntfs_dt *dt, int new) { @@ -239,7 +266,12 @@ BOOL ntfs_dt_resize_children3(struct ntfs_dt *dt, int new) } /** - * ntfs_dt_root_count + * ntfs_dt_root_count - + * @dt: + * + * Description... + * + * Returns: */ int ntfs_dt_root_count(struct ntfs_dt *dt) { @@ -302,7 +334,12 @@ int ntfs_dt_root_count(struct ntfs_dt *dt) } /** - * ntfs_dt_alloc_count + * ntfs_dt_alloc_count - + * @dt: + * + * Description... + * + * Returns: */ int ntfs_dt_alloc_count(struct ntfs_dt *dt) { @@ -361,7 +398,13 @@ int ntfs_dt_alloc_count(struct ntfs_dt *dt) } /** - * ntfs_dt_initialise2 + * ntfs_dt_initialise2 - + * @vol: + * @dt: + * + * Description... + * + * Returns: */ int ntfs_dt_initialise2(ntfs_volume *vol, struct ntfs_dt *dt) { @@ -404,7 +447,14 @@ int ntfs_dt_initialise2(ntfs_volume *vol, struct ntfs_dt *dt) } /** - * ntfs_dt_create + * ntfs_dt_create - + * @dir: + * @parent: + * @vcn: + * + * Description... + * + * Returns: */ struct ntfs_dt * ntfs_dt_create(struct ntfs_dir *dir, struct ntfs_dt *parent, VCN vcn) { @@ -504,7 +554,11 @@ struct ntfs_dt * ntfs_dt_create(struct ntfs_dir *dir, struct ntfs_dt *parent, VC } /** - * ntfs_dt_find + * ntfs_dt_find - + * @dt: + * @name: + * @name_len: + * * find dt by name, return MFT_REF * maps dt's as necessary */ @@ -580,7 +634,12 @@ MFT_REF ntfs_dt_find(struct ntfs_dt *dt, ntfschar *name, int name_len) } /** - * ntfs_dt_find2 + * ntfs_dt_find2 - + * @dt: + * @name: + * @name_len: + * @index_num: + * * find dt by name, returns dt and index * maps dt's as necessary */ @@ -659,7 +718,12 @@ struct ntfs_dt * ntfs_dt_find2(struct ntfs_dt *dt, ntfschar *name, int name_len, } /** - * ntfs_dt_find3 + * ntfs_dt_find3 - + * @dt: + * @name: + * @name_len: + * @index_num: + * * find dt by name, returns dt and index * does not map new dt's */ @@ -720,7 +784,12 @@ struct ntfs_dt * ntfs_dt_find3(struct ntfs_dt *dt, ntfschar *name, int name_len, } /** - * ntfs_dt_find4 + * ntfs_dt_find4 - + * @dt: + * @name: + * @name_len: + * @index_num: + * * find successor to specified name, returns dt and index * maps dt's as necessary */ @@ -789,7 +858,9 @@ struct ntfs_dt * ntfs_dt_find4(struct ntfs_dt *dt, ntfschar *name, int name_len, } /** - * ntfs_dt_find_all + * ntfs_dt_find_all - + * @dt: + * * maps all dt's into memory */ void ntfs_dt_find_all(struct ntfs_dt *dt) @@ -816,7 +887,12 @@ void ntfs_dt_find_all(struct ntfs_dt *dt) } /** - * ntfs_dt_find_parent + * ntfs_dt_find_parent - + * @dt: + * + * Description... + * + * Returns: */ int ntfs_dt_find_parent(struct ntfs_dt *dt) { @@ -839,7 +915,12 @@ int ntfs_dt_find_parent(struct ntfs_dt *dt) } /** - * ntfs_dt_isroot + * ntfs_dt_isroot - + * @dt: + * + * Description... + * + * Returns: */ BOOL ntfs_dt_isroot(struct ntfs_dt *dt) { @@ -850,7 +931,12 @@ BOOL ntfs_dt_isroot(struct ntfs_dt *dt) } /** - * ntfs_dt_root_freespace + * ntfs_dt_root_freespace - + * @dt: + * + * Description... + * + * Returns: */ int ntfs_dt_root_freespace(struct ntfs_dt *dt) { @@ -871,7 +957,12 @@ int ntfs_dt_root_freespace(struct ntfs_dt *dt) } /** - * ntfs_dt_alloc_freespace + * ntfs_dt_alloc_freespace - + * @dt: + * + * Description... + * + * Returns: */ int ntfs_dt_alloc_freespace(struct ntfs_dt *dt) { @@ -892,7 +983,15 @@ int ntfs_dt_alloc_freespace(struct ntfs_dt *dt) } /** - * ntfs_dt_transfer + * ntfs_dt_transfer - + * @old: + * @new: + * @start: + * @count: + * + * Description... + * + * Returns: */ int ntfs_dt_transfer(struct ntfs_dt *old, struct ntfs_dt *new, int start, int count) { @@ -1042,7 +1141,14 @@ int ntfs_dt_transfer(struct ntfs_dt *old, struct ntfs_dt *new, int start, int co } /** - * ntfs_dt_alloc_insert + * ntfs_dt_alloc_insert - + * @dt: + * @first: + * @count: + * + * Description... + * + * Returns: */ int ntfs_dt_alloc_insert(struct ntfs_dt *dt, INDEX_ENTRY *first, int count) { @@ -1106,7 +1212,15 @@ int ntfs_dt_alloc_insert(struct ntfs_dt *dt, INDEX_ENTRY *first, int count) } /** - * ntfs_dt_alloc_insert2 + * ntfs_dt_alloc_insert2 - + * @dt: + * @before: + * @count: + * @bytes: + * + * Description... + * + * Returns: */ INDEX_ENTRY * ntfs_dt_alloc_insert2(struct ntfs_dt *dt, int before, int count, int bytes) { @@ -1173,7 +1287,14 @@ INDEX_ENTRY * ntfs_dt_alloc_insert2(struct ntfs_dt *dt, int before, int count, i } /** - * ntfs_dt_root_insert + * ntfs_dt_root_insert - + * @dt: + * @first: + * @count: + * + * Description... + * + * Returns: */ int ntfs_dt_root_insert(struct ntfs_dt *dt, INDEX_ENTRY *first, int count) { @@ -1187,7 +1308,14 @@ int ntfs_dt_root_insert(struct ntfs_dt *dt, INDEX_ENTRY *first, int count) } /** - * ntfs_dt_alloc_remove2 + * ntfs_dt_alloc_remove2 - + * @dt: + * @start: + * @count: + * + * Description... + * + * Returns: */ int ntfs_dt_alloc_remove2(struct ntfs_dt *dt, int start, int count) { @@ -1207,7 +1335,14 @@ int ntfs_dt_alloc_remove2(struct ntfs_dt *dt, int start, int count) } /** - * ntfs_dt_root_remove2 + * ntfs_dt_root_remove2 - + * @dt: + * @start: + * @count: + * + * Description... + * + * Returns: */ int ntfs_dt_root_remove2(struct ntfs_dt *dt, int start, int count) { @@ -1249,7 +1384,15 @@ int ntfs_dt_root_remove2(struct ntfs_dt *dt, int start, int count) } /** - * ntfs_dt_transfer2 + * ntfs_dt_transfer2 - + * @old: + * @new: + * @start: + * @count: + * + * Description... + * + * Returns: */ int ntfs_dt_transfer2(struct ntfs_dt *old, struct ntfs_dt *new, int start, int count) { @@ -1410,7 +1553,15 @@ int ntfs_dt_transfer2(struct ntfs_dt *old, struct ntfs_dt *new, int start, int c } /** - * ntfs_dt_root_replace + * ntfs_dt_root_replace - + * @del: + * @del_num: + * @del_ie: + * @suc_ie: + * + * Description... + * + * Returns: */ int ntfs_dt_root_replace(struct ntfs_dt *del, int del_num, INDEX_ENTRY *del_ie, INDEX_ENTRY *suc_ie) { @@ -1490,7 +1641,15 @@ int ntfs_dt_root_replace(struct ntfs_dt *del, int del_num, INDEX_ENTRY *del_ie, } /** - * ntfs_dt_alloc_replace + * ntfs_dt_alloc_replace - + * @del: + * @del_num: + * @del_ie: + * @suc_ie: + * + * Description... + * + * Returns: */ BOOL ntfs_dt_alloc_replace(struct ntfs_dt *del, int del_num, INDEX_ENTRY *del_ie, INDEX_ENTRY *suc_ie) { @@ -1553,7 +1712,13 @@ BOOL ntfs_dt_alloc_replace(struct ntfs_dt *del, int del_num, INDEX_ENTRY *del_ie } /** - * ntfs_dt_root_remove + * ntfs_dt_root_remove - + * @del: + * @del_num: + * + * Description... + * + * Returns: */ BOOL ntfs_dt_root_remove(struct ntfs_dt *del, int del_num) { @@ -1675,7 +1840,13 @@ BOOL ntfs_dt_root_remove(struct ntfs_dt *del, int del_num) } /** - * ntfs_dt_alloc_remove + * ntfs_dt_alloc_remove - + * @del: + * @del_num: + * + * Description... + * + * Returns: */ BOOL ntfs_dt_alloc_remove(struct ntfs_dt *del, int del_num) { @@ -1798,7 +1969,15 @@ BOOL ntfs_dt_alloc_remove(struct ntfs_dt *del, int del_num) } /** - * ntfs_dt_alloc_add + * ntfs_dt_alloc_add - + * @parent: + * @index_num: + * @ie: + * @child: + * + * Description... + * + * Returns: */ int ntfs_dt_alloc_add(struct ntfs_dt *parent, int index_num, INDEX_ENTRY *ie, struct ntfs_dt *child) { @@ -1887,7 +2066,15 @@ int ntfs_dt_alloc_add(struct ntfs_dt *parent, int index_num, INDEX_ENTRY *ie, st } /** - * ntfs_dt_root_add + * ntfs_dt_root_add - + * @parent: + * @index_num: + * @ie: + * @child: + * + * Description... + * + * Returns: */ int ntfs_dt_root_add(struct ntfs_dt *parent, int index_num, INDEX_ENTRY *ie, struct ntfs_dt *child) { @@ -1990,7 +2177,15 @@ int ntfs_dt_root_add(struct ntfs_dt *parent, int index_num, INDEX_ENTRY *ie, str } /** - * ntfs_dt_add2 + * ntfs_dt_add2 - + * @ie: + * @suc: + * @suc_num: + * @ded: + * + * Description... + * + * Returns: */ int ntfs_dt_add2(INDEX_ENTRY *ie, struct ntfs_dt *suc, int suc_num, struct ntfs_dt *ded) { diff --git a/libntfs/unistr.c b/libntfs/unistr.c index a8b91d20..f34355ff 100644 --- a/libntfs/unistr.c +++ b/libntfs/unistr.c @@ -123,7 +123,7 @@ BOOL ntfs_names_are_equal(const ntfschar *s1, size_t s1_len, */ int ntfs_names_collate(const ntfschar *name1, const u32 name1_len, const ntfschar *name2, const u32 name2_len, - const int err_val __attribute__((__unused__)), + const int err_val __attribute__((unused)), const IGNORE_CASE_BOOL ic, const ntfschar *upcase, const u32 upcase_len) { @@ -307,7 +307,15 @@ ntfschar *ntfs_ucsndup(const ntfschar *s, u32 maxlen) } /** - * ntfs_name_upcase + * ntfs_name_upcase - + * @name: + * @name_len: + * @upcase: + * @upcase_len: + * + * Description... + * + * Returns: */ void ntfs_name_upcase(ntfschar *name, u32 name_len, const ntfschar *upcase, const u32 upcase_len) @@ -321,7 +329,14 @@ void ntfs_name_upcase(ntfschar *name, u32 name_len, const ntfschar *upcase, } /** - * ntfs_file_value_upcase + * ntfs_file_value_upcase - + * @file_name_attr: + * @upcase: + * @upcase_len: + * + * Description... + * + * Returns: */ void ntfs_file_value_upcase(FILE_NAME_ATTR *file_name_attr, const ntfschar *upcase, const u32 upcase_len) @@ -331,7 +346,17 @@ void ntfs_file_value_upcase(FILE_NAME_ATTR *file_name_attr, } /** - * ntfs_file_values_compare + * ntfs_file_values_compare - + * @file_name_attr1: + * @file_name_attr2: + * @err_val: + * @ic: + * @upcase: + * @upcase_len: + * + * Description... + * + * Returns: */ int ntfs_file_values_compare(const FILE_NAME_ATTR *file_name_attr1, const FILE_NAME_ATTR *file_name_attr2, diff --git a/libntfs/unix_io.c b/libntfs/unix_io.c index a91b6431..8cc94c1f 100644 --- a/libntfs/unix_io.c +++ b/libntfs/unix_io.c @@ -67,7 +67,13 @@ #define DEV_FD(dev) (*(int *)dev->d_private) /** - * ntfs_device_unix_io_open + * ntfs_device_unix_io_open - + * @dev: + * @flags: + * + * Description... + * + * Returns: */ static int ntfs_device_unix_io_open(struct ntfs_device *dev, int flags) { @@ -116,7 +122,12 @@ err_out: } /** - * ntfs_device_unix_io_close + * ntfs_device_unix_io_close - + * @dev: + * + * Description... + * + * Returns: */ static int ntfs_device_unix_io_close(struct ntfs_device *dev) { @@ -146,7 +157,14 @@ static int ntfs_device_unix_io_close(struct ntfs_device *dev) } /** - * ntfs_device_unix_io_seek + * ntfs_device_unix_io_seek - + * @dev: + * @offset: + * @whence: + * + * Description... + * + * Returns: */ static s64 ntfs_device_unix_io_seek(struct ntfs_device *dev, s64 offset, int whence) @@ -155,7 +173,14 @@ static s64 ntfs_device_unix_io_seek(struct ntfs_device *dev, s64 offset, } /** - * ntfs_device_unix_io_read + * ntfs_device_unix_io_read - + * @dev: + * @buf: + * @count: + * + * Description... + * + * Returns: */ static s64 ntfs_device_unix_io_read(struct ntfs_device *dev, void *buf, s64 count) @@ -164,7 +189,14 @@ static s64 ntfs_device_unix_io_read(struct ntfs_device *dev, void *buf, } /** - * ntfs_device_unix_io_write + * ntfs_device_unix_io_write - + * @dev: + * @buf: + * @count: + * + * Description... + * + * Returns: */ static s64 ntfs_device_unix_io_write(struct ntfs_device *dev, const void *buf, s64 count) @@ -178,7 +210,15 @@ static s64 ntfs_device_unix_io_write(struct ntfs_device *dev, const void *buf, } /** - * ntfs_device_unix_io_pread + * ntfs_device_unix_io_pread - + * @dev: + * @buf: + * @count: + * @offset: + * + * Description... + * + * Returns: */ static s64 ntfs_device_unix_io_pread(struct ntfs_device *dev, void *buf, s64 count, s64 offset) @@ -187,7 +227,15 @@ static s64 ntfs_device_unix_io_pread(struct ntfs_device *dev, void *buf, } /** - * ntfs_device_unix_io_pwrite + * ntfs_device_unix_io_pwrite - + * @dev: + * @buf: + * @count: + * @offset: + * + * Description... + * + * Returns: */ static s64 ntfs_device_unix_io_pwrite(struct ntfs_device *dev, const void *buf, s64 count, s64 offset) @@ -201,7 +249,12 @@ static s64 ntfs_device_unix_io_pwrite(struct ntfs_device *dev, const void *buf, } /** - * ntfs_device_unix_io_sync + * ntfs_device_unix_io_sync - + * @dev: + * + * Description... + * + * Returns: */ static int ntfs_device_unix_io_sync(struct ntfs_device *dev) { @@ -215,7 +268,13 @@ static int ntfs_device_unix_io_sync(struct ntfs_device *dev) } /** - * ntfs_device_unix_io_stat + * ntfs_device_unix_io_stat - + * @dev: + * @buf: + * + * Description... + * + * Returns: */ static int ntfs_device_unix_io_stat(struct ntfs_device *dev, struct stat *buf) { @@ -223,7 +282,14 @@ static int ntfs_device_unix_io_stat(struct ntfs_device *dev, struct stat *buf) } /** - * ntfs_device_unix_io_ioctl + * ntfs_device_unix_io_ioctl - + * @dev: + * @request: + * @argp: + * + * Description... + * + * Returns: */ static int ntfs_device_unix_io_ioctl(struct ntfs_device *dev, int request, void *argp) diff --git a/libntfs/volume.c b/libntfs/volume.c index fcbd36b0..598ae14e 100644 --- a/libntfs/volume.c +++ b/libntfs/volume.c @@ -68,6 +68,10 @@ /** * ntfs_volume_alloc - + * + * Description... + * + * Returns: */ ntfs_volume *ntfs_volume_alloc(void) { @@ -91,9 +95,12 @@ ntfs_volume *ntfs_volume_alloc(void) } /** - * Internal: - * * __ntfs_volume_release - + * @v: + * + * Description... + * + * Returns: */ static void __ntfs_volume_release(ntfs_volume *v) { @@ -134,8 +141,6 @@ static void __ntfs_volume_release(ntfs_volume *v) } /** - * Internal: - * * ntfs_mft_load - load the $MFT and setup the ntfs volume with it * @vol: ntfs volume whose $MFT to load * @@ -329,8 +334,6 @@ error_exit: } /** - * Internal: - * * ntfs_mftmirr_load - load the $MFTMirr and setup the ntfs volume with it * @vol: ntfs volume whose $MFTMirr to load * @@ -1266,8 +1269,6 @@ int ntfs_umount(ntfs_volume *vol, #ifndef HAVE_REALPATH /** - * Internal: - * * realpath - If there is no realpath on the system */ static char *realpath(const char *path, char *resolved_path) @@ -1277,9 +1278,8 @@ static char *realpath(const char *path, char *resolved_path) return resolved_path; } #endif + /** - * Internal: - * * ntfs_mntent_check - desc * * If you are wanting to use this, you actually wanted to use @@ -1606,7 +1606,14 @@ int utils_valid_device(const char *name, int force) } /** - * utils_mount_volume + * utils_mount_volume - + * @device: + * @flags: + * @force: + * + * Description... + * + * Returns: */ ntfs_volume * utils_mount_volume(const char *device, unsigned long flags, BOOL force) { @@ -1653,7 +1660,12 @@ ntfs_volume * utils_mount_volume(const char *device, unsigned long flags, BOOL f } /** - * ntfs_volume_commit + * ntfs_volume_commit - + * @vol: + * + * Description... + * + * Returns: */ int ntfs_volume_commit(ntfs_volume *vol) { @@ -1675,7 +1687,12 @@ int ntfs_volume_commit(ntfs_volume *vol) } /** - * ntfs_volume_rollback + * ntfs_volume_rollback - + * @vol: + * + * Description... + * + * Returns: */ int ntfs_volume_rollback(ntfs_volume *vol) { @@ -1696,7 +1713,13 @@ int ntfs_volume_rollback(ntfs_volume *vol) } /** - * ntfs_volume_umount2 + * ntfs_volume_umount2 - + * @vol: + * @force: + * + * Description... + * + * Returns: */ int ntfs_volume_umount2(ntfs_volume *vol, const BOOL force) { @@ -1725,7 +1748,14 @@ int ntfs_volume_umount2(ntfs_volume *vol, const BOOL force) } /** - * ntfs_volume_mount2 + * ntfs_volume_mount2 - + * @device: + * @flags: + * @force: + * + * Description... + * + * Returns: */ ntfs_volume * ntfs_volume_mount2(const char *device, unsigned long flags, BOOL force) {