diff options
author | Christian Grothoff <christian@grothoff.org> | 2009-09-22 19:06:35 +0000 |
---|---|---|
committer | Christian Grothoff <christian@grothoff.org> | 2009-09-22 19:06:35 +0000 |
commit | 4ad96e182037d35ec6e62a8bfb1d2ea9b14be106 (patch) | |
tree | 7e5b055bce051c11bfd460443956e619466d4710 /src/fs | |
parent | d62bacc863759d211988cd59d0f0849e378d2a61 (diff) | |
download | gnunet-4ad96e182037d35ec6e62a8bfb1d2ea9b14be106.tar.gz gnunet-4ad96e182037d35ec6e62a8bfb1d2ea9b14be106.zip |
documentation cleanup
Diffstat (limited to 'src/fs')
-rw-r--r-- | src/fs/fs_download.c | 9 | ||||
-rw-r--r-- | src/fs/fs_search.c | 2 | ||||
-rw-r--r-- | src/fs/fs_unindex.c | 5 | ||||
-rw-r--r-- | src/fs/fs_uri.c | 4 | ||||
-rw-r--r-- | src/fs/gnunet-directory.c | 6 | ||||
-rw-r--r-- | src/fs/gnunet-download.c | 2 | ||||
-rw-r--r-- | src/fs/gnunet-publish.c | 2 | ||||
-rw-r--r-- | src/fs/gnunet-search.c | 2 |
8 files changed, 19 insertions, 13 deletions
diff --git a/src/fs/fs_download.c b/src/fs/fs_download.c index 9ab4c5ce0..f36807e77 100644 --- a/src/fs/fs_download.c +++ b/src/fs/fs_download.c | |||
@@ -128,7 +128,7 @@ compute_dblock_offset (uint64_t offset, | |||
128 | * Fill in all of the generic fields for | 128 | * Fill in all of the generic fields for |
129 | * a download event. | 129 | * a download event. |
130 | * | 130 | * |
131 | * @param pc structure to fill in | 131 | * @param pi structure to fill in |
132 | * @param dc overall download context | 132 | * @param dc overall download context |
133 | */ | 133 | */ |
134 | static void | 134 | static void |
@@ -229,7 +229,8 @@ try_reconnect (struct GNUNET_FS_DownloadContext *dc); | |||
229 | * the specified node. | 229 | * the specified node. |
230 | * | 230 | * |
231 | * @param fsize overall file size | 231 | * @param fsize overall file size |
232 | * @param off offset of the node | 232 | * @param totaldepth depth of the entire tree |
233 | * @param offset offset of the node | ||
233 | * @param depth depth of the node | 234 | * @param depth depth of the node |
234 | * @return number of bytes stored in this node | 235 | * @return number of bytes stored in this node |
235 | */ | 236 | */ |
@@ -269,9 +270,9 @@ calculate_block_size (uint64_t fsize, | |||
269 | 270 | ||
270 | 271 | ||
271 | /** | 272 | /** |
272 | * Process a search result. | 273 | * Process a download result. |
273 | * | 274 | * |
274 | * @param sc our search context | 275 | * @param dc our download context |
275 | * @param type type of the result | 276 | * @param type type of the result |
276 | * @param data the (encrypted) response | 277 | * @param data the (encrypted) response |
277 | * @param size size of data | 278 | * @param size size of data |
diff --git a/src/fs/fs_search.c b/src/fs/fs_search.c index 1a9fc699e..85d65f483 100644 --- a/src/fs/fs_search.c +++ b/src/fs/fs_search.c | |||
@@ -46,7 +46,7 @@ | |||
46 | * Fill in all of the generic fields for | 46 | * Fill in all of the generic fields for |
47 | * a search event. | 47 | * a search event. |
48 | * | 48 | * |
49 | * @param pc structure to fill in | 49 | * @param pi structure to fill in |
50 | * @param sc overall search context | 50 | * @param sc overall search context |
51 | */ | 51 | */ |
52 | static void | 52 | static void |
diff --git a/src/fs/fs_unindex.c b/src/fs/fs_unindex.c index 977344b98..51d46ea37 100644 --- a/src/fs/fs_unindex.c +++ b/src/fs/fs_unindex.c | |||
@@ -82,8 +82,9 @@ unindex_reader (void *cls, | |||
82 | * Fill in all of the generic fields for | 82 | * Fill in all of the generic fields for |
83 | * an unindex event. | 83 | * an unindex event. |
84 | * | 84 | * |
85 | * @param pc structure to fill in | 85 | * @param pi structure to fill in |
86 | * @param sc overall unindex context | 86 | * @param uc overall unindex context |
87 | * @param offset where we are in the file (for progress) | ||
87 | */ | 88 | */ |
88 | static void | 89 | static void |
89 | make_unindex_status (struct GNUNET_FS_ProgressInfo *pi, | 90 | make_unindex_status (struct GNUNET_FS_ProgressInfo *pi, |
diff --git a/src/fs/fs_uri.c b/src/fs/fs_uri.c index 1c0686ed9..38dba8991 100644 --- a/src/fs/fs_uri.c +++ b/src/fs/fs_uri.c | |||
@@ -470,7 +470,7 @@ c2v (unsigned char a) | |||
470 | /** | 470 | /** |
471 | * Convert string back to binary data. | 471 | * Convert string back to binary data. |
472 | * | 472 | * |
473 | * @param input '\0'-terminated string | 473 | * @param input '\\0'-terminated string |
474 | * @param data where to write binary data | 474 | * @param data where to write binary data |
475 | * @param size how much data should be converted | 475 | * @param size how much data should be converted |
476 | * @return number of characters processed from input, | 476 | * @return number of characters processed from input, |
@@ -808,7 +808,7 @@ GNUNET_FS_uri_loc_get_uri (const struct GNUNET_FS_Uri *uri) | |||
808 | /** | 808 | /** |
809 | * Construct a location URI (this peer will be used for the location). | 809 | * Construct a location URI (this peer will be used for the location). |
810 | * | 810 | * |
811 | * @param baseURI content offered by the sender | 811 | * @param baseUri content offered by the sender |
812 | * @param cfg configuration information (used to find our hostkey) | 812 | * @param cfg configuration information (used to find our hostkey) |
813 | * @param expiration_time how long will the content be offered? | 813 | * @param expiration_time how long will the content be offered? |
814 | * @return the location URI, NULL on error | 814 | * @return the location URI, NULL on error |
diff --git a/src/fs/gnunet-directory.c b/src/fs/gnunet-directory.c index 0cbf700d1..8fc477614 100644 --- a/src/fs/gnunet-directory.c +++ b/src/fs/gnunet-directory.c | |||
@@ -29,6 +29,10 @@ static int ret; | |||
29 | 29 | ||
30 | /** | 30 | /** |
31 | * Print a meta data entry. | 31 | * Print a meta data entry. |
32 | * | ||
33 | * @param cls closure (unused) | ||
34 | * @param type type of the keyword | ||
35 | * @param data value of the keyword | ||
32 | */ | 36 | */ |
33 | static int | 37 | static int |
34 | item_printer (void *cls, | 38 | item_printer (void *cls, |
@@ -49,7 +53,7 @@ item_printer (void *cls, | |||
49 | * @param cls closure (not used) | 53 | * @param cls closure (not used) |
50 | * @param filename name of the file in the directory | 54 | * @param filename name of the file in the directory |
51 | * @param uri URI of the file | 55 | * @param uri URI of the file |
52 | * @param metadata metadata for the file; metadata for | 56 | * @param meta metadata for the file; metadata for |
53 | * the directory if everything else is NULL/zero | 57 | * the directory if everything else is NULL/zero |
54 | * @param length length of the available data for the file | 58 | * @param length length of the available data for the file |
55 | * (of type size_t since data must certainly fit | 59 | * (of type size_t since data must certainly fit |
diff --git a/src/fs/gnunet-download.c b/src/fs/gnunet-download.c index 681608d6b..00565b1a3 100644 --- a/src/fs/gnunet-download.c +++ b/src/fs/gnunet-download.c | |||
@@ -113,7 +113,7 @@ progress_cb (void *cls, | |||
113 | * @param sched the scheduler to use | 113 | * @param sched the scheduler to use |
114 | * @param args remaining command-line arguments | 114 | * @param args remaining command-line arguments |
115 | * @param cfgfile name of the configuration file used (for saving, can be NULL!) | 115 | * @param cfgfile name of the configuration file used (for saving, can be NULL!) |
116 | * @param cfg configuration | 116 | * @param c configuration |
117 | */ | 117 | */ |
118 | static void | 118 | static void |
119 | run (void *cls, | 119 | run (void *cls, |
diff --git a/src/fs/gnunet-publish.c b/src/fs/gnunet-publish.c index a30b36c9e..bf6a46914 100644 --- a/src/fs/gnunet-publish.c +++ b/src/fs/gnunet-publish.c | |||
@@ -258,7 +258,7 @@ publish_inspector (void *cls, | |||
258 | * @param sched the scheduler to use | 258 | * @param sched the scheduler to use |
259 | * @param args remaining command-line arguments | 259 | * @param args remaining command-line arguments |
260 | * @param cfgfile name of the configuration file used (for saving, can be NULL!) | 260 | * @param cfgfile name of the configuration file used (for saving, can be NULL!) |
261 | * @param cfg configuration | 261 | * @param c configuration |
262 | */ | 262 | */ |
263 | static void | 263 | static void |
264 | run (void *cls, | 264 | run (void *cls, |
diff --git a/src/fs/gnunet-search.c b/src/fs/gnunet-search.c index b744d2e1a..ed864fa1c 100644 --- a/src/fs/gnunet-search.c +++ b/src/fs/gnunet-search.c | |||
@@ -134,7 +134,7 @@ progress_cb (void *cls, | |||
134 | * @param sched the scheduler to use | 134 | * @param sched the scheduler to use |
135 | * @param args remaining command-line arguments | 135 | * @param args remaining command-line arguments |
136 | * @param cfgfile name of the configuration file used (for saving, can be NULL!) | 136 | * @param cfgfile name of the configuration file used (for saving, can be NULL!) |
137 | * @param cfg configuration | 137 | * @param c configuration |
138 | */ | 138 | */ |
139 | static void | 139 | static void |
140 | run (void *cls, | 140 | run (void *cls, |