From 96796ab9baedee8b7de8d9ffc9e19dc0d8f8327a Mon Sep 17 00:00:00 2001 From: Pauli Date: Sat, 22 Oct 2022 14:09:06 +1100 Subject: Fix documenation mistakes Reviewed-by: Tim Hudson Reviewed-by: Shane Lontis (Merged from https://github.com/openssl/openssl/pull/19377) --- doc/internal/man3/DEFINE_LIST_OF.pod | 38 ++++++++++++++++++------------------ 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/doc/internal/man3/DEFINE_LIST_OF.pod b/doc/internal/man3/DEFINE_LIST_OF.pod index 311c200b7a..d886defc43 100644 --- a/doc/internal/man3/DEFINE_LIST_OF.pod +++ b/doc/internal/man3/DEFINE_LIST_OF.pod @@ -51,55 +51,55 @@ The OSSL_LIST() macro returns the name for a list of the specified B>. This is a structure which should be treated as opaque. DEFINE_LIST_OF() creates a set of functions for a list of B> -elements with the name B>. The type is represented -by B(B>) and each function name begins with -B_>. The list's linkages are stored in the -B(B>, B>) field. +elements with the name B>. The type is represented +by B(B>) and each function name begins with +B_>. The list's linkages are stored in the +B(B>, B>) field. -B_init>() initialises the memory pointed to by I +B_init>() initialises the memory pointed to by I to zero which creates an empty list. -B_init_elem>() initialises the list related memory pointed +B_init_elem>() initialises the list related memory pointed to by I to zero which allows it to be used in lists. -B_is_empty>() returns nonzero if I has no elements and +B_is_empty>() returns nonzero if I has no elements and zero otherwise. -B_num>() returns the number of elements in I. +B_num>() returns the number of elements in I. -B_head>() returns the first element in the I +B_head>() returns the first element in the I or NULL if there are no elements. -B_tail>() returns the last element in the I +B_tail>() returns the last element in the I or NULL if there are no elements. -B_remove>() removes the specified element I from +B_remove>() removes the specified element I from the I. It is illegal to remove an element that isn't in the list. -B_insert_head>() inserts the element I, which +B_insert_head>() inserts the element I, which must not be in the list, into the first position in the I. -B_insert_tail>() inserts the element I, which +B_insert_tail>() inserts the element I, which must not be in the list, into the last position in the I. -B_insert_before>() inserts the element I, +B_insert_before>() inserts the element I, which must not be in the list, into the I immediately before the I element. -B_insert_after>() inserts the element I, +B_insert_after>() inserts the element I, which must not be in the list, into the I immediately after the I element. =head1 RETURN VALUES -B_is_empty>() returns nonzero if the list is empty and zero +B_is_empty>() returns nonzero if the list is empty and zero otherwise. -B_num>() returns the number of elements in the +B_num>() returns the number of elements in the list. -B_head>(), B_tail>(), -B_next>() and B_prev>() return +B_head>(), B_tail>(), +B_next>() and B_prev>() return the specified element in the list. =head1 EXAMPLES -- cgit v1.2.3