1=pod
2
3=head1 NAME
4
5OSSL_DEPRECATED, OSSL_DEPRECATED_FOR - General deprecation macros
6
7=head1 SYNOPSIS
8
9 #include <openssl/macros.h>
10
11 #define OSSL_DEPRECATED(since)
12 #define OSSL_DEPRECATED_FOR(since, msg)
13
14=head1 DESCRIPTION
15
16OSSL_DEPRECATED() implements the deprecated attribute if the compiler
17supports it, otherwise it expands to nothing.  It takes one argument
18I<since> that should be set to the OpenSSL version where the symbol was
19deprecated, and will be displayed with the deprecation warning message,
20for compilers that support user specified deprecation messages.
21
22OSSL_DEPRECATED_FOR() does the same as OSSL_DEPRECATED(), but also takes a
23second argument I<msg>, which is an additional text messages to be displayed
24with the deprecation warning along with the OpenSSL version number, for
25compilers that support user specified deprecation messages.
26
27These macros are used to define the version specific deprecation macros
28described in L<deprecation(7)>.
29
30=begin comment
31
32[RETURN VALUES isn't relevant for these macros, but find-doc-nits demands
33the presence of this section]
34
35=head1 RETURN VALUES
36
37[podchecker doesn't like empty sections]
38
39=end comment
40
41=head1 SEE ALSO
42
43L<deprecation(7)>
44
45=head1 COPYRIGHT
46
47Copyright 2020 The OpenSSL Project Authors. All Rights Reserved.
48
49Licensed under the Apache License 2.0 (the "License").  You may not use
50this file except in compliance with the License.  You can obtain a copy
51in the file LICENSE in the source distribution or at
52L<https://www.openssl.org/source/license.html>.
53
54=cut
55