summaryrefslogtreecommitdiffstats
path: root/doc/man3/BIO_s_mem.pod
diff options
context:
space:
mode:
authorRich Salz <rsalz@akamai.com>2019-08-15 13:52:41 -0400
committerDr. Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com>2019-08-19 00:03:33 +0200
commit39a117d17963d0cd4a8f3a3351c0844c325e905c (patch)
tree3875c3ab5ebc8ee35d11b625a1d57a2ce2fab91b /doc/man3/BIO_s_mem.pod
parente0249827b3fa81ff6c59fb14ef85d38361dd5e31 (diff)
Fix some pod-page ordering nits
The find-doc-nits script only looked for EXAMPLES, not EXAMPLE. Fix the pattern and then fix the errors that resulted. Reviewed-by: Richard Levitte <levitte@openssl.org> Reviewed-by: Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com> (Merged from https://github.com/openssl/openssl/pull/9602)
Diffstat (limited to 'doc/man3/BIO_s_mem.pod')
-rw-r--r--doc/man3/BIO_s_mem.pod19
1 files changed, 10 insertions, 9 deletions
diff --git a/doc/man3/BIO_s_mem.pod b/doc/man3/BIO_s_mem.pod
index 7cb9efa92c..b7c6fdf860 100644
--- a/doc/man3/BIO_s_mem.pod
+++ b/doc/man3/BIO_s_mem.pod
@@ -118,7 +118,16 @@ BIO_FLAGS_NONCLEAR_RST set has the same effect as a write operation.
There should be an option to set the maximum size of a memory BIO.
-=head1 EXAMPLE
+=head1 RETURN VALUES
+
+BIO_s_mem() and BIO_s_secmem() return a valid memory B<BIO_METHOD> structure.
+
+BIO_set_mem_eof_return(), BIO_get_mem_data(), BIO_set_mem_buf() and BIO_get_mem_ptr()
+return 1 on success or a value which is less than or equal to 0 if an error occurred.
+
+BIO_new_mem_buf() returns a valid B<BIO> structure on success or NULL on error.
+
+=head1 EXAMPLES
Create a memory BIO and write some data to it:
@@ -139,14 +148,6 @@ Extract the BUF_MEM structure from a memory BIO and then free up the BIO:
BIO_set_close(mem, BIO_NOCLOSE); /* So BIO_free() leaves BUF_MEM alone */
BIO_free(mem);
-=head1 RETURN VALUES
-
-BIO_s_mem() and BIO_s_secmem() return a valid memory B<BIO_METHOD> structure.
-
-BIO_set_mem_eof_return(), BIO_get_mem_data(), BIO_set_mem_buf() and BIO_get_mem_ptr()
-return 1 on success or a value which is less than or equal to 0 if an error occurred.
-
-BIO_new_mem_buf() returns a valid B<BIO> structure on success or NULL on error.
=head1 COPYRIGHT