diff options
author | Christian Grothoff <christian@grothoff.org> | 2013-10-06 09:20:29 +0000 |
---|---|---|
committer | Christian Grothoff <christian@grothoff.org> | 2013-10-06 09:20:29 +0000 |
commit | f046cc8d56d765ad1250474636b5a10272a66292 (patch) | |
tree | a9e9bb1aeb6c4a8b926626abd896e35b7842d88a /src/include/gnunet_bio_lib.h | |
parent | 03acdb1b1764cb9ae65d255c3e4f9606e824f80b (diff) | |
download | gnunet-f046cc8d56d765ad1250474636b5a10272a66292.tar.gz gnunet-f046cc8d56d765ad1250474636b5a10272a66292.zip |
-doxygen fixes
Diffstat (limited to 'src/include/gnunet_bio_lib.h')
-rw-r--r-- | src/include/gnunet_bio_lib.h | 24 |
1 files changed, 11 insertions, 13 deletions
diff --git a/src/include/gnunet_bio_lib.h b/src/include/gnunet_bio_lib.h index d54184c8e..c5db08e16 100644 --- a/src/include/gnunet_bio_lib.h +++ b/src/include/gnunet_bio_lib.h | |||
@@ -72,7 +72,7 @@ GNUNET_BIO_read_close (struct GNUNET_BIO_ReadHandle *h, char **emsg); | |||
72 | * @param what describes what is being read (for error message creation) | 72 | * @param what describes what is being read (for error message creation) |
73 | * @param result the buffer to write the result to | 73 | * @param result the buffer to write the result to |
74 | * @param len the number of bytes to read | 74 | * @param len the number of bytes to read |
75 | * @return GNUNET_OK on success, GNUNET_SYSERR on failure | 75 | * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure |
76 | */ | 76 | */ |
77 | int | 77 | int |
78 | GNUNET_BIO_read (struct GNUNET_BIO_ReadHandle *h, const char *what, | 78 | GNUNET_BIO_read (struct GNUNET_BIO_ReadHandle *h, const char *what, |
@@ -87,7 +87,7 @@ GNUNET_BIO_read (struct GNUNET_BIO_ReadHandle *h, const char *what, | |||
87 | * @param line line number in the source file | 87 | * @param line line number in the source file |
88 | * @param result the buffer to write the result to | 88 | * @param result the buffer to write the result to |
89 | * @param len the number of bytes to read | 89 | * @param len the number of bytes to read |
90 | * @return GNUNET_OK on success, GNUNET_SYSERR on failure | 90 | * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure |
91 | */ | 91 | */ |
92 | int | 92 | int |
93 | GNUNET_BIO_read_fn (struct GNUNET_BIO_ReadHandle *h, const char *file, int line, | 93 | GNUNET_BIO_read_fn (struct GNUNET_BIO_ReadHandle *h, const char *file, int line, |
@@ -101,7 +101,7 @@ GNUNET_BIO_read_fn (struct GNUNET_BIO_ReadHandle *h, const char *file, int line, | |||
101 | * @param result the buffer to store a pointer to the (allocated) string to | 101 | * @param result the buffer to store a pointer to the (allocated) string to |
102 | * (note that *result could be set to NULL as well) | 102 | * (note that *result could be set to NULL as well) |
103 | * @param maxLen maximum allowed length for the string | 103 | * @param maxLen maximum allowed length for the string |
104 | * @return GNUNET_OK on success, GNUNET_SYSERR on failure | 104 | * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure |
105 | */ | 105 | */ |
106 | int | 106 | int |
107 | GNUNET_BIO_read_string (struct GNUNET_BIO_ReadHandle *h, const char *what, | 107 | GNUNET_BIO_read_string (struct GNUNET_BIO_ReadHandle *h, const char *what, |
@@ -114,7 +114,7 @@ GNUNET_BIO_read_string (struct GNUNET_BIO_ReadHandle *h, const char *what, | |||
114 | * @param h handle to an open file | 114 | * @param h handle to an open file |
115 | * @param what describes what is being read (for error message creation) | 115 | * @param what describes what is being read (for error message creation) |
116 | * @param result the buffer to store a pointer to the (allocated) metadata | 116 | * @param result the buffer to store a pointer to the (allocated) metadata |
117 | * @return GNUNET_OK on success, GNUNET_SYSERR on failure | 117 | * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure |
118 | */ | 118 | */ |
119 | int | 119 | int |
120 | GNUNET_BIO_read_meta_data (struct GNUNET_BIO_ReadHandle *h, const char *what, | 120 | GNUNET_BIO_read_meta_data (struct GNUNET_BIO_ReadHandle *h, const char *what, |
@@ -147,7 +147,7 @@ GNUNET_BIO_read_meta_data (struct GNUNET_BIO_ReadHandle *h, const char *what, | |||
147 | * @param file name of the source file | 147 | * @param file name of the source file |
148 | * @param line line number in the code | 148 | * @param line line number in the code |
149 | * @param i address of 32-bit integer to read | 149 | * @param i address of 32-bit integer to read |
150 | * @return GNUNET_OK on success, GNUNET_SYSERR on error | 150 | * @return #GNUNET_OK on success, #GNUNET_SYSERR on error |
151 | */ | 151 | */ |
152 | int | 152 | int |
153 | GNUNET_BIO_read_int32__ (struct GNUNET_BIO_ReadHandle *h, const char *file, | 153 | GNUNET_BIO_read_int32__ (struct GNUNET_BIO_ReadHandle *h, const char *file, |
@@ -170,7 +170,7 @@ GNUNET_BIO_read_int32__ (struct GNUNET_BIO_ReadHandle *h, const char *file, | |||
170 | * @param file name of the source file | 170 | * @param file name of the source file |
171 | * @param line line number in the code | 171 | * @param line line number in the code |
172 | * @param i address of 64-bit integer to read | 172 | * @param i address of 64-bit integer to read |
173 | * @return GNUNET_OK on success, GNUNET_SYSERR on error | 173 | * @return #GNUNET_OK on success, #GNUNET_SYSERR on error |
174 | */ | 174 | */ |
175 | int | 175 | int |
176 | GNUNET_BIO_read_int64__ (struct GNUNET_BIO_ReadHandle *h, const char *file, | 176 | GNUNET_BIO_read_int64__ (struct GNUNET_BIO_ReadHandle *h, const char *file, |
@@ -217,7 +217,7 @@ GNUNET_BIO_write_close (struct GNUNET_BIO_WriteHandle *h); | |||
217 | * @param h handle to open file | 217 | * @param h handle to open file |
218 | * @param buffer the data to write | 218 | * @param buffer the data to write |
219 | * @param n number of bytes to write | 219 | * @param n number of bytes to write |
220 | * @return GNUNET_OK on success, GNUNET_SYSERR on error | 220 | * @return #GNUNET_OK on success, #GNUNET_SYSERR on error |
221 | */ | 221 | */ |
222 | int | 222 | int |
223 | GNUNET_BIO_write (struct GNUNET_BIO_WriteHandle *h, const void *buffer, | 223 | GNUNET_BIO_write (struct GNUNET_BIO_WriteHandle *h, const void *buffer, |
@@ -228,7 +228,7 @@ GNUNET_BIO_write (struct GNUNET_BIO_WriteHandle *h, const void *buffer, | |||
228 | * Force a buffered writer to flush its buffer | 228 | * Force a buffered writer to flush its buffer |
229 | * | 229 | * |
230 | * @param h the writer handle | 230 | * @param h the writer handle |
231 | * @return GNUNET_OK upon success. Upon failure GNUNET_SYSERR is returned and | 231 | * @return #GNUNET_OK upon success. Upon failure #GNUNET_SYSERR is returned and |
232 | * the file is closed | 232 | * the file is closed |
233 | */ | 233 | */ |
234 | int | 234 | int |
@@ -240,20 +240,18 @@ GNUNET_BIO_flush (struct GNUNET_BIO_WriteHandle *h); | |||
240 | * | 240 | * |
241 | * @param h handle to open file | 241 | * @param h handle to open file |
242 | * @param s string to write (can be NULL) | 242 | * @param s string to write (can be NULL) |
243 | * @return GNUNET_OK on success, GNUNET_SYSERR on error | 243 | * @return #GNUNET_OK on success, #GNUNET_SYSERR on error |
244 | */ | 244 | */ |
245 | int | 245 | int |
246 | GNUNET_BIO_write_string (struct GNUNET_BIO_WriteHandle *h, const char *s); | 246 | GNUNET_BIO_write_string (struct GNUNET_BIO_WriteHandle *h, const char *s); |
247 | 247 | ||
248 | 248 | ||
249 | |||
250 | |||
251 | /** | 249 | /** |
252 | * Write metadata container to a file. | 250 | * Write metadata container to a file. |
253 | * | 251 | * |
254 | * @param h handle to open file | 252 | * @param h handle to open file |
255 | * @param m metadata to write | 253 | * @param m metadata to write |
256 | * @return GNUNET_OK on success, GNUNET_SYSERR on error | 254 | * @return #GNUNET_OK on success, #GNUNET_SYSERR on error |
257 | */ | 255 | */ |
258 | int | 256 | int |
259 | GNUNET_BIO_write_meta_data (struct GNUNET_BIO_WriteHandle *h, | 257 | GNUNET_BIO_write_meta_data (struct GNUNET_BIO_WriteHandle *h, |
@@ -296,7 +294,7 @@ GNUNET_BIO_write_int32 (struct GNUNET_BIO_WriteHandle *h, int32_t i); | |||
296 | * | 294 | * |
297 | * @param h hande to open file | 295 | * @param h hande to open file |
298 | * @param i 64-bit integer to write | 296 | * @param i 64-bit integer to write |
299 | * @return GNUNET_OK on success, GNUNET_SYSERR on error | 297 | * @return #GNUNET_OK on success, #GNUNET_SYSERR on error |
300 | */ | 298 | */ |
301 | int | 299 | int |
302 | GNUNET_BIO_write_int64 (struct GNUNET_BIO_WriteHandle *h, int64_t i); | 300 | GNUNET_BIO_write_int64 (struct GNUNET_BIO_WriteHandle *h, int64_t i); |