Skip to content

Commit 252e747

Browse files
Rearrange code examples in docs for clarity
The introduction of a deprecation notice between the header include line and the function prototypes left the inclusion in the previous block. Move the #include to after the deprecation notice to ensure that the headers is included together with the corresponding MDX_y* functions.
1 parent 6eb6489 commit 252e747

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

doc/man3/MD5.pod

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,38 +7,37 @@ MD4_Final, MD5_Init, MD5_Update, MD5_Final - MD2, MD4, and MD5 hash functions
77

88
=head1 SYNOPSIS
99

10-
#include <openssl/md2.h>
11-
1210
The following functions have been deprecated since OpenSSL 3.0, and can be
1311
hidden entirely by defining B<OPENSSL_API_COMPAT> with a suitable version value,
1412
see L<openssl_user_macros(7)>:
1513

14+
#include <openssl/md2.h>
15+
1616
unsigned char *MD2(const unsigned char *d, unsigned long n, unsigned char *md);
1717

1818
int MD2_Init(MD2_CTX *c);
1919
int MD2_Update(MD2_CTX *c, const unsigned char *data, unsigned long len);
2020
int MD2_Final(unsigned char *md, MD2_CTX *c);
2121

2222

23-
#include <openssl/md4.h>
24-
2523
The following functions have been deprecated since OpenSSL 3.0, and can be
2624
hidden entirely by defining B<OPENSSL_API_COMPAT> with a suitable version value,
2725
see L<openssl_user_macros(7)>:
2826

27+
#include <openssl/md4.h>
28+
2929
unsigned char *MD4(const unsigned char *d, unsigned long n, unsigned char *md);
3030

3131
int MD4_Init(MD4_CTX *c);
3232
int MD4_Update(MD4_CTX *c, const void *data, unsigned long len);
3333
int MD4_Final(unsigned char *md, MD4_CTX *c);
3434

35-
36-
#include <openssl/md5.h>
37-
3835
The following functions have been deprecated since OpenSSL 3.0, and can be
3936
hidden entirely by defining B<OPENSSL_API_COMPAT> with a suitable version value,
4037
see L<openssl_user_macros(7)>:
4138

39+
#include <openssl/md5.h>
40+
4241
unsigned char *MD5(const unsigned char *d, unsigned long n, unsigned char *md);
4342

4443
int MD5_Init(MD5_CTX *c);

0 commit comments

Comments
 (0)