From 63e3a4416b93f9c309568aec1207b1b60a6ae668 Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Wed, 20 Jul 2016 23:52:21 +0200 Subject: fix doc style MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- doc/man/libcoopgamma_async_context_initialise.3 | 4 ++-- doc/man/libcoopgamma_connect.3 | 4 ++-- doc/man/libcoopgamma_context_initialise.3 | 4 ++-- doc/man/libcoopgamma_crtc_info_initialise.3 | 4 ++-- doc/man/libcoopgamma_error_initialise.3 | 4 ++-- doc/man/libcoopgamma_filter_initialise.3 | 4 ++-- doc/man/libcoopgamma_filter_query_initialise.3 | 4 ++-- doc/man/libcoopgamma_filter_table_initialise.3 | 4 ++-- doc/man/libcoopgamma_flush.3 | 4 ++-- doc/man/libcoopgamma_get_crtcs_send.3 | 4 ++-- doc/man/libcoopgamma_get_method_and_site.3 | 4 ++-- doc/man/libcoopgamma_get_methods.3 | 2 +- doc/man/libcoopgamma_get_pid_file.3 | 6 +++--- doc/man/libcoopgamma_get_socket_file.3 | 6 +++--- doc/man/libcoopgamma_queried_filter_initialise.3 | 4 ++-- doc/man/libcoopgamma_ramps_initialise.3 | 4 ++-- doc/man/libcoopgamma_set_nonblocking.3 | 4 ++-- doc/man/libcoopgamma_synchronise.3 | 4 ++-- 18 files changed, 37 insertions(+), 37 deletions(-) (limited to 'doc') diff --git a/doc/man/libcoopgamma_async_context_initialise.3 b/doc/man/libcoopgamma_async_context_initialise.3 index 2b35a66..24cf859 100644 --- a/doc/man/libcoopgamma_async_context_initialise.3 +++ b/doc/man/libcoopgamma_async_context_initialise.3 @@ -21,9 +21,9 @@ On failure, should be deinitialised using .BR libcoopgamma_async_context_destroy (3). .SH "RETURN VALUES" -The +Upon successful completion, the .BR libcoopgamma_async_context_initialise () -returns 0 on success. On error, -1 is returned and +function returns 0. On error, -1 is returned and .I errno is set appropriately. .SH "ERRORS" diff --git a/doc/man/libcoopgamma_connect.3 b/doc/man/libcoopgamma_connect.3 index 5125690..e32b864 100644 --- a/doc/man/libcoopgamma_connect.3 +++ b/doc/man/libcoopgamma_connect.3 @@ -42,9 +42,9 @@ function will not temporarily reset handling of .I SIGCHLD itself. .SH "RETURN VALUES" -The +Upon successful completion, the .BR libcoopgamma_connect () -returns 0 on success. On error, -1 is returned and +function returns 0. On error, -1 is returned and .I errno is set appropriately. .SH "ERRORS" diff --git a/doc/man/libcoopgamma_context_initialise.3 b/doc/man/libcoopgamma_context_initialise.3 index a843488..367c0a9 100644 --- a/doc/man/libcoopgamma_context_initialise.3 +++ b/doc/man/libcoopgamma_context_initialise.3 @@ -21,9 +21,9 @@ On failure, should be deinitialised using .BR libcoopgamma_context_destroy (3). .SH "RETURN VALUES" -The +Upon successful completion, the .BR libcoopgamma_context_initialise () -returns 0 on success. On error, -1 is returned and +function returns 0. On error, -1 is returned and .I errno is set appropriately. .SH "ERRORS" diff --git a/doc/man/libcoopgamma_crtc_info_initialise.3 b/doc/man/libcoopgamma_crtc_info_initialise.3 index f060125..84f167d 100644 --- a/doc/man/libcoopgamma_crtc_info_initialise.3 +++ b/doc/man/libcoopgamma_crtc_info_initialise.3 @@ -21,9 +21,9 @@ On failure, should be deinitialised using .BR libcoopgamma_crtc_info_destroy (3). .SH "RETURN VALUES" -The +Upon successful completion, the .BR libcoopgamma_crtc_info_initialise () -returns 0 on success. On error, -1 is returned and +function returns 0. On error, -1 is returned and .I errno is set appropriately. .SH "ERRORS" diff --git a/doc/man/libcoopgamma_error_initialise.3 b/doc/man/libcoopgamma_error_initialise.3 index 88156d6..fba20cf 100644 --- a/doc/man/libcoopgamma_error_initialise.3 +++ b/doc/man/libcoopgamma_error_initialise.3 @@ -21,9 +21,9 @@ On failure, should be deinitialised using .BR libcoopgamma_error_destroy (3). .SH "RETURN VALUES" -The +Upon successful completion, the .BR libcoopgamma_error_initialise () -returns 0 on success. On error, -1 is returned and +function returns 0. On error, -1 is returned and .I errno is set appropriately. .SH "ERRORS" diff --git a/doc/man/libcoopgamma_filter_initialise.3 b/doc/man/libcoopgamma_filter_initialise.3 index 4ccc5ee..d2889b4 100644 --- a/doc/man/libcoopgamma_filter_initialise.3 +++ b/doc/man/libcoopgamma_filter_initialise.3 @@ -21,9 +21,9 @@ On failure, should be deinitialised using .BR libcoopgamma_filter_destroy (3). .SH "RETURN VALUES" -The +Upon successful completion, the .BR libcoopgamma_filter_initialise () -returns 0 on success. On error, -1 is returned and +function returns 0. On error, -1 is returned and .I errno is set appropriately. .SH "ERRORS" diff --git a/doc/man/libcoopgamma_filter_query_initialise.3 b/doc/man/libcoopgamma_filter_query_initialise.3 index c3f3b8a..e2a8903 100644 --- a/doc/man/libcoopgamma_filter_query_initialise.3 +++ b/doc/man/libcoopgamma_filter_query_initialise.3 @@ -21,9 +21,9 @@ On failure, should be deinitialised using .BR libcoopgamma_filter_query_destroy (3). .SH "RETURN VALUES" -The +Upon successful completion, the .BR libcoopgamma_filter_query_initialise () -returns 0 on success. On error, -1 is returned and +function returns 0. On error, -1 is returned and .I errno is set appropriately. .SH "ERRORS" diff --git a/doc/man/libcoopgamma_filter_table_initialise.3 b/doc/man/libcoopgamma_filter_table_initialise.3 index 4b73b09..79ee8cf 100644 --- a/doc/man/libcoopgamma_filter_table_initialise.3 +++ b/doc/man/libcoopgamma_filter_table_initialise.3 @@ -21,9 +21,9 @@ On failure, should be deinitialised using .BR libcoopgamma_filter_table_destroy (3). .SH "RETURN VALUES" -The +Upon successful completion, the .BR libcoopgamma_filter_table_initialise () -returns 0 on success. On error, -1 is returned and +function returns 0. On error, -1 is returned and .I errno is set appropriately. .SH "ERRORS" diff --git a/doc/man/libcoopgamma_flush.3 b/doc/man/libcoopgamma_flush.3 index ab602a8..8ffaae2 100644 --- a/doc/man/libcoopgamma_flush.3 +++ b/doc/man/libcoopgamma_flush.3 @@ -18,9 +18,9 @@ function sends all data on that have not yet been sent because of interruption or similar. .SH "RETURN VALUES" -The +Upon successful completion, the .BR libcoopgamma_flush () -returns 0 on success. On error, -1 is returned and +function returns 0. On error, -1 is returned and .I errno is set appropriately. .SH "ERRORS" diff --git a/doc/man/libcoopgamma_get_crtcs_send.3 b/doc/man/libcoopgamma_get_crtcs_send.3 index dfab036..ec34e55 100644 --- a/doc/man/libcoopgamma_get_crtcs_send.3 +++ b/doc/man/libcoopgamma_get_crtcs_send.3 @@ -26,9 +26,9 @@ to identify the response, and by .BR libcoopgamma_get_crtcs_recv (3) to parse the response. .SH "RETURN VALUES" -The +Upon successful completion, the .BR libcoopgamma_get_crtcs_send () -returns 0 on success. On error, -1 is returned and +function returns 0. On error, -1 is returned and .I errno is set appropriately. .SH "ERRORS" diff --git a/doc/man/libcoopgamma_get_method_and_site.3 b/doc/man/libcoopgamma_get_method_and_site.3 index 30ddfb7..5dcd2f5 100644 --- a/doc/man/libcoopgamma_get_method_and_site.3 +++ b/doc/man/libcoopgamma_get_method_and_site.3 @@ -66,9 +66,9 @@ function will not temporarily reset handling of .I SIGCHLD itself. .SH "RETURN VALUES" -The +Upon successful completion, the .BR libcoopgamma_get_method_and_site () -function returns 0 on success. On error, -1 +function returns 0. On error, -1 is returned and -1 is set appropriately. .SH "ERRORS" The diff --git a/doc/man/libcoopgamma_get_methods.3 b/doc/man/libcoopgamma_get_methods.3 index 4cf90b8..b2ce807 100644 --- a/doc/man/libcoopgamma_get_methods.3 +++ b/doc/man/libcoopgamma_get_methods.3 @@ -33,7 +33,7 @@ function will not temporarily reset handling of .I SIGCHLD itself. .SH "RETURN VALUES" -The +Upon successful completion, the .BR libcoopgamma_get_methods () function returns a list of recognised adjustment method name. The list is terminated diff --git a/doc/man/libcoopgamma_get_pid_file.3 b/doc/man/libcoopgamma_get_pid_file.3 index dadc1a4..3d312ef 100644 --- a/doc/man/libcoopgamma_get_pid_file.3 +++ b/doc/man/libcoopgamma_get_pid_file.3 @@ -43,10 +43,10 @@ function will not temporarily reset handling of .I SIGCHLD itself. .SH "RETURN VALUES" -The +Upon successful completion, the .BR libcoopgamma_get_pid_file () -function the pathname of the PID file on success. -Success does not mean that the server has the +function returns the pathname of the PID file. +Success does not mean that the server is necessarily running at the moment. The user should free the returned pointer. On error, .I NULL diff --git a/doc/man/libcoopgamma_get_socket_file.3 b/doc/man/libcoopgamma_get_socket_file.3 index 5e81e0c..f73f0ca 100644 --- a/doc/man/libcoopgamma_get_socket_file.3 +++ b/doc/man/libcoopgamma_get_socket_file.3 @@ -44,10 +44,10 @@ function will not temporarily reset handling of .I SIGCHLD itself. .SH "RETURN VALUES" -The +Upon successful completion, the .BR libcoopgamma_get_socket_file () -function the pathname of the socket on success. -Success does not mean that the server has the +function returns the pathname of the socket. +Success does not mean that the server is necessarily running at the moment. The user should free the returned pointer. On error, .I NULL diff --git a/doc/man/libcoopgamma_queried_filter_initialise.3 b/doc/man/libcoopgamma_queried_filter_initialise.3 index ac72e5d..79f2c59 100644 --- a/doc/man/libcoopgamma_queried_filter_initialise.3 +++ b/doc/man/libcoopgamma_queried_filter_initialise.3 @@ -21,9 +21,9 @@ On failure, should be deinitialised using .BR libcoopgamma_queried_filter_destroy (3). .SH "RETURN VALUES" -The +Upon successful completion, the .BR libcoopgamma_queried_filter_initialise () -returns 0 on success. On error, -1 is returned and +function returns 0. On error, -1 is returned and .I errno is set appropriately. .SH "ERRORS" diff --git a/doc/man/libcoopgamma_ramps_initialise.3 b/doc/man/libcoopgamma_ramps_initialise.3 index 69154b5..f6ee3d2 100644 --- a/doc/man/libcoopgamma_ramps_initialise.3 +++ b/doc/man/libcoopgamma_ramps_initialise.3 @@ -38,9 +38,9 @@ On failure, should be deinitialised using .BR libcoopgamma_ramps_destroy (3). .SH "RETURN VALUES" -The +Upon successful completion, the .BR libcoopgamma_ramps_initialise () -returns 0 on success. On error, -1 is returned and +function returns 0. On error, -1 is returned and .I errno is set appropriately. .SH "ERRORS" diff --git a/doc/man/libcoopgamma_set_nonblocking.3 b/doc/man/libcoopgamma_set_nonblocking.3 index 821a0c6..7e6ceb6 100644 --- a/doc/man/libcoopgamma_set_nonblocking.3 +++ b/doc/man/libcoopgamma_set_nonblocking.3 @@ -26,9 +26,9 @@ which is achieved by calling the .BR libcoopgamma_connect (3) functon. .SH "RETURN VALUES" -The +Upon successful completion, the .BR libcoopgamma_set_nonblocking () -returns 0 on success. On error, -1 is returned and +function returns 0. On error, -1 is returned and .I errno is set appropriately. .SH "ERRORS" diff --git a/doc/man/libcoopgamma_synchronise.3 b/doc/man/libcoopgamma_synchronise.3 index 9fbb300..d466778 100644 --- a/doc/man/libcoopgamma_synchronise.3 +++ b/doc/man/libcoopgamma_synchronise.3 @@ -32,9 +32,9 @@ is set to the index of the context in representing the context for the asynchronous call to which the received message is a response. .SH "RETURN VALUES" -The +Upon successful completion, the .BR libcoopgamma_synchronise () -returns 0 on success. On error, -1 is returned and +function returns 0. On error, -1 is returned and .I errno is set appropriately. .SH "ERRORS" -- cgit v1.2.3-70-g09d2