From efaf4da6edb0c20579b530bff289edc8d4d5fb03 Mon Sep 17 00:00:00 2001 From: Matteo Cypriani Date: Wed, 11 Sep 2013 17:32:56 -0400 Subject: [PATCH] [doc] Somewhat improve Doxygen-generated man pages Fix some problems in the Doxygen-generated man pages (C libraries), the more noticeable being removing the full path of the files from the header and synopsis. --- doc/Doxyfile | 2 +- libowlps-client/libowlps-client.c | 6 +++--- libowlps-client/owlps-client.h | 1 + libowlps-resultreader/libowlps-resultreader.c | 8 ++++---- libowlps/libowlps.c | 2 +- libowlps/owlps.h | 4 ++-- 6 files changed, 12 insertions(+), 11 deletions(-) diff --git a/doc/Doxyfile b/doc/Doxyfile index 1f4a86a..24ee44d 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -121,7 +121,7 @@ INLINE_INHERITED_MEMB = NO # path before files name in the file list and in the header files. If set # to NO the shortest path that makes the file name unique will be used. -FULL_PATH_NAMES = YES +FULL_PATH_NAMES = NO # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag # can be used to strip a user-defined part of the path. Stripping is diff --git a/libowlps-client/libowlps-client.c b/libowlps-client/libowlps-client.c index ea3e38e..2c084f6 100644 --- a/libowlps-client/libowlps-client.c +++ b/libowlps-client/libowlps-client.c @@ -29,7 +29,7 @@ /** * Opens a transmission UDP socket to a server in a simplified way. - * This function uses `owl_create_udp_trx_socket()` (from libowlps) + * This function uses owl_create_udp_trx_socket() (from libowlps) * as a backend, and allows to select a particular network interface. * * @param[in] dest_ip IP address of the remote server. @@ -98,7 +98,7 @@ void owl_use_iface(const int sockfd, const char *const iface) * @param[in] sockfd The file descriptor of the socket to use for the * transmission. * @param[in] server The server's information (as generated by - * `owl_create_trx_socket()`, for example). + * owl_create_trx_socket(), for example). * @param[in] packet The buffer to send through the socket. * @param[in] packet_size The buffer's size. * @param[in] nb_pkt Number of packets to transmit. @@ -145,7 +145,7 @@ void owl_send_request(const int sockfd, /** * Transmits a single packet of a request. - * See the documentation of the `owl_send_request()` function for an + * See the documentation of the owl_send_request() function for an * explanation on the parameters. * When `verbose` if `true`, a dot will be printed on the standard output * and the standard output will be flushed. diff --git a/libowlps-client/owlps-client.h b/libowlps-client/owlps-client.h index b1cf8fc..346021c 100644 --- a/libowlps-client/owlps-client.h +++ b/libowlps-client/owlps-client.h @@ -42,6 +42,7 @@ void owl_send_request(const int sockfd, const uint_fast16_t nb_pkt, const uint_fast32_t delay, const bool verbose) ; +/// Transmits a packet void owl_send_packet(const int sockfd, const struct sockaddr_in *const server, const void *const packet, diff --git a/libowlps-resultreader/libowlps-resultreader.c b/libowlps-resultreader/libowlps-resultreader.c index d83fb10..9840faf 100644 --- a/libowlps-resultreader/libowlps-resultreader.c +++ b/libowlps-resultreader/libowlps-resultreader.c @@ -40,7 +40,7 @@ * deleted using `free()`. * * 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. * * @returns A pointer to a new `owl_result`. * @returns `NULL` in case of error. @@ -263,7 +263,7 @@ owl_algorithm_result* owl_fill_algorithm_result(char **csv) /** - * Converts an `owl_result back` to a CSV string. + * Converts an `owl_result` back to a CSV string. * `dst` must be an allocated string of at least `OWL_CSV_RESULT_STRLEN` * characters. * @@ -273,7 +273,7 @@ owl_algorithm_result* owl_fill_algorithm_result(char **csv) * * *Nb_algo* is the number of algorithms in the result. * The format of *Algo_i* is documented in the documentation of the - * `owl_algorithm_result_to_csv()` function. + * owl_algorithm_result_to_csv() function. */ void owl_result_to_csv(char dst[OWL_CSV_RESULT_STRLEN], const owl_result *const src) @@ -349,7 +349,7 @@ owl_algorithm_result_to_csv(char dst[OWL_CSV_ALGORITHM_RESULT_STRLEN], * * *First_algorithm* is the first algorithm in `src->results`. Its format * is documented in the documentation of the - * `owl_algorithm_result_to_csv_simple()` function. + * owl_algorithm_result_to_csv_simple() function. */ void owl_result_to_csv_simple(char dst[OWL_CSV_RESULT_SIMPLE_STRLEN], const owl_result *const src) diff --git a/libowlps/libowlps.c b/libowlps/libowlps.c index ced95ff..77a467a 100644 --- a/libowlps/libowlps.c +++ b/libowlps/libowlps.c @@ -382,7 +382,7 @@ void owl_ntoh_timestamp(owl_timestamp *const d) /** * This function swaps the bytes composing a `float`, i.e. it changes * their order. - * You probably want to use the `owl_htonf()` and `owl_ntohf()` macros + * You probably want to use the owl_htonf() and owl_ntohf() macros * instead of this function. * * @returns The swapped `float`. diff --git a/libowlps/owlps.h b/libowlps/owlps.h index 699f030..2828623 100644 --- a/libowlps/owlps.h +++ b/libowlps/owlps.h @@ -372,7 +372,7 @@ float owl_swap_float(const float f) ; * * This macro converts the byte order of a `float` if needed, depending * on the endianness of the host, to adopt the endianness of the network. - * To actually change the byte order, the `owl_swap_float()` function is + * To actually change the byte order, the owl_swap_float() function is * used. * * @def owl_ntohf @@ -381,7 +381,7 @@ float owl_swap_float(const float f) ; * This macro converts the byte order of a `float` encoded with a network * endianness to adopt the endianness of the host, if the two endianness * are different. - * To actually change the byte order, the `owl_swap_float()` function is + * To actually change the byte order, the owl_swap_float() function is * used. */ //@}