aboutsummaryrefslogtreecommitdiff
path: root/src/fs/fs_file_information.c
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2013-09-14 13:51:27 +0000
committerChristian Grothoff <christian@grothoff.org>2013-09-14 13:51:27 +0000
commitc2882d0223530d1f2ac84f9675f23bda11270d08 (patch)
tree77c5a7973735a93e58e482d1a21ecd62bf6d08bf /src/fs/fs_file_information.c
parente5ba359af49fac05185f5ec0b4dbb47c7060167a (diff)
downloadgnunet-c2882d0223530d1f2ac84f9675f23bda11270d08.tar.gz
gnunet-c2882d0223530d1f2ac84f9675f23bda11270d08.zip
-fixing #3034
Diffstat (limited to 'src/fs/fs_file_information.c')
-rw-r--r--src/fs/fs_file_information.c30
1 files changed, 15 insertions, 15 deletions
diff --git a/src/fs/fs_file_information.c b/src/fs/fs_file_information.c
index 3e6d53af6..da4e85b78 100644
--- a/src/fs/fs_file_information.c
+++ b/src/fs/fs_file_information.c
@@ -37,8 +37,7 @@
37 * 37 *
38 * @param s structure to get the filename for 38 * @param s structure to get the filename for
39 * @return NULL on error, otherwise filename that 39 * @return NULL on error, otherwise filename that
40 * can be passed to "GNUNET_FS_file_information_recover" 40 * can be used to read this fi-struct from disk.
41 * to read this fi-struct from disk.
42 */ 41 */
43const char * 42const char *
44GNUNET_FS_file_information_get_id (struct GNUNET_FS_FileInformation *s) 43GNUNET_FS_file_information_get_id (struct GNUNET_FS_FileInformation *s)
@@ -80,6 +79,7 @@ GNUNET_FS_file_information_set_filename (struct GNUNET_FS_FileInformation *s,
80 s->filename = NULL; 79 s->filename = NULL;
81} 80}
82 81
82
83/** 83/**
84 * Create an entry for a file in a publish-structure. 84 * Create an entry for a file in a publish-structure.
85 * 85 *
@@ -89,8 +89,8 @@ GNUNET_FS_file_information_set_filename (struct GNUNET_FS_FileInformation *s,
89 * @param keywords under which keywords should this file be available 89 * @param keywords under which keywords should this file be available
90 * directly; can be NULL 90 * directly; can be NULL
91 * @param meta metadata for the file 91 * @param meta metadata for the file
92 * @param do_index GNUNET_YES for index, GNUNET_NO for insertion, 92 * @param do_index #GNUNET_YES for index, #GNUNET_NO for insertion,
93 * GNUNET_SYSERR for simulation 93 * #GNUNET_SYSERR for simulation
94 * @param bo block options 94 * @param bo block options
95 * @return publish structure entry for the file 95 * @return publish structure entry for the file
96 */ 96 */
@@ -215,8 +215,8 @@ GNUNET_FS_file_information_create_from_data (struct GNUNET_FS_Handle *h,
215 * @param keywords under which keywords should this file be available 215 * @param keywords under which keywords should this file be available
216 * directly; can be NULL 216 * directly; can be NULL
217 * @param meta metadata for the file 217 * @param meta metadata for the file
218 * @param do_index GNUNET_YES for index, GNUNET_NO for insertion, 218 * @param do_index #GNUNET_YES for index, #GNUNET_NO for insertion,
219 * GNUNET_SYSERR for simulation 219 * #GNUNET_SYSERR for simulation
220 * @param bo block options 220 * @param bo block options
221 * @return publish structure entry for the file 221 * @return publish structure entry for the file
222 */ 222 */
@@ -316,13 +316,13 @@ GNUNET_FS_file_information_create_empty_directory (struct GNUNET_FS_Handle *h,
316/** 316/**
317 * Add an entry to a directory in a publish-structure. Clients 317 * Add an entry to a directory in a publish-structure. Clients
318 * should never modify publish structures that were passed to 318 * should never modify publish structures that were passed to
319 * "GNUNET_FS_publish_start" already. 319 * #GNUNET_FS_publish_start already.
320 * 320 *
321 * @param dir the directory 321 * @param dir the directory
322 * @param ent the entry to add; the entry must not have been 322 * @param ent the entry to add; the entry must not have been
323 * added to any other directory at this point and 323 * added to any other directory at this point and
324 * must not include "dir" in its structure 324 * must not include @a dir in its structure
325 * @return GNUNET_OK on success, GNUNET_SYSERR on error 325 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
326 */ 326 */
327int 327int
328GNUNET_FS_file_information_add (struct GNUNET_FS_FileInformation *dir, 328GNUNET_FS_file_information_add (struct GNUNET_FS_FileInformation *dir,
@@ -344,16 +344,16 @@ GNUNET_FS_file_information_add (struct GNUNET_FS_FileInformation *dir,
344/** 344/**
345 * Inspect a file or directory in a publish-structure. Clients 345 * Inspect a file or directory in a publish-structure. Clients
346 * should never modify publish structures that were passed to 346 * should never modify publish structures that were passed to
347 * "GNUNET_FS_publish_start" already. When called on a directory, 347 * #GNUNET_FS_publish_start already. When called on a directory,
348 * this function will FIRST call "proc" with information about 348 * this function will FIRST call @a proc with information about
349 * the directory itself and then for each of the files in the 349 * the directory itself and then for each of the files in the
350 * directory (but not for files in subdirectories). When called 350 * directory (but not for files in subdirectories). When called
351 * on a file, "proc" will be called exactly once (with information 351 * on a file, @a proc will be called exactly once (with information
352 * about the specific file). 352 * about the specific file).
353 * 353 *
354 * @param dir the directory 354 * @param dir the directory
355 * @param proc function to call on each entry 355 * @param proc function to call on each entry
356 * @param proc_cls closure for proc 356 * @param proc_cls closure for @a proc
357 */ 357 */
358void 358void
359GNUNET_FS_file_information_inspect (struct GNUNET_FS_FileInformation *dir, 359GNUNET_FS_file_information_inspect (struct GNUNET_FS_FileInformation *dir,
@@ -392,13 +392,13 @@ GNUNET_FS_file_information_inspect (struct GNUNET_FS_FileInformation *dir,
392 392
393/** 393/**
394 * Destroy publish-structure. Clients should never destroy publish 394 * Destroy publish-structure. Clients should never destroy publish
395 * structures that were passed to "GNUNET_FS_publish_start" already. 395 * structures that were passed to #GNUNET_FS_publish_start already.
396 * 396 *
397 * @param fi structure to destroy 397 * @param fi structure to destroy
398 * @param cleaner function to call on each entry in the structure 398 * @param cleaner function to call on each entry in the structure
399 * (useful to clean up client_info); can be NULL; return 399 * (useful to clean up client_info); can be NULL; return
400 * values are ignored 400 * values are ignored
401 * @param cleaner_cls closure for cleaner 401 * @param cleaner_cls closure for @a cleaner
402 */ 402 */
403void 403void
404GNUNET_FS_file_information_destroy (struct GNUNET_FS_FileInformation *fi, 404GNUNET_FS_file_information_destroy (struct GNUNET_FS_FileInformation *fi,