[lib-result] Fix some comments

This commit is contained in:
Matteo Cypriani 2013-09-23 15:46:01 -04:00
parent e5883d99d5
commit 51837c0ac1
1 changed files with 5 additions and 5 deletions

View File

@ -37,7 +37,7 @@
* pointer to it. * pointer to it.
* *
* Note that the new owl_result is allocated with `malloc()` and must be * Note that the new owl_result is allocated with `malloc()` and must be
* deleted using `free()`. * deleted using `owl_free_result()`.
* *
* In case of error, a message is printed, except if `owl_run` (from * In case of error, a message is printed, except if `owl_run` (from
* owlps.h) is `false`, and `NULL` is returned. * owlps.h) is `false`, and `NULL` is returned.
@ -72,7 +72,7 @@ owl_result* owl_receive_position(const int sockfd)
* if preservation of the original value is desired. * if preservation of the original value is desired.
* *
* Note that the new `owl_result` is allocated with `malloc()` and must * Note that the new `owl_result` is allocated with `malloc()` and must
* be deleted using `free()`. * be deleted using `owl_free_result()`.
* *
* Handled CSV format: * Handled CSV format:
* *
@ -178,7 +178,7 @@ owl_result* owl_fill_result(char *csv)
* if preservation of the original value is desired. * if preservation of the original value is desired.
* *
* Note that the new owl_algorithm_result is allocated with `malloc()` * Note that the new owl_algorithm_result is allocated with `malloc()`
* and must be deleted using `free()`. * and must be deleted using `owl_free_algorithm_result()`.
* *
* Handled CSV format: * Handled CSV format:
* *
@ -468,7 +468,7 @@ void owl_fprint_algorithm_result(FILE *stream,
* Frees the memory allocated for an `owl_result`. The `results` and * Frees the memory allocated for an `owl_result`. The `results` and
* `mobile_mac_addr` fields of `result` *must* be defined, either to * `mobile_mac_addr` fields of `result` *must* be defined, either to
* `NULL` or to a valid memory block allocated with `malloc()`. * `NULL` or to a valid memory block allocated with `malloc()`.
* Note that `result` will not set to `NULL`. * Note that `result` will not be set to `NULL`.
*/ */
void owl_free_result(owl_result *const result) void owl_free_result(owl_result *const result)
{ {
@ -490,7 +490,7 @@ void owl_free_result(owl_result *const result)
* recursively). The `algorithm` and `area` fields of `algo` *must* be * recursively). The `algorithm` and `area` fields of `algo` *must* be
* defined, either to `NULL` or to a valid memory block allocated with * defined, either to `NULL` or to a valid memory block allocated with
* `malloc()`. * `malloc()`.
* Note that `algo` will not set to `NULL`. * Note that `algo` will not be set to `NULL`.
*/ */
void owl_free_algorithm_result(owl_algorithm_result *const algo) void owl_free_algorithm_result(owl_algorithm_result *const algo)
{ {