diff options
| author | Jeffrey Walton <noloader@gmail.com> | 2020-12-25 13:45:42 -0500 |
|---|---|---|
| committer | Jeffrey Walton <noloader@gmail.com> | 2020-12-25 13:45:42 -0500 |
| commit | 8f1746790eee65207f127674a883a16fd6179d32 (patch) | |
| tree | e0986afe3afbdc3669bcb2974e30c73d5e8f4ba0 /config_ver.h | |
| parent | 446aef2e5ea823c174df0037a8844e715283226d (diff) | |
| download | cryptopp-git-8f1746790eee65207f127674a883a16fd6179d32.tar.gz | |
Update documentation
Diffstat (limited to 'config_ver.h')
| -rw-r--r-- | config_ver.h | 33 |
1 files changed, 29 insertions, 4 deletions
diff --git a/config_ver.h b/config_ver.h index be8aef2f..b4115f66 100644 --- a/config_ver.h +++ b/config_ver.h @@ -4,24 +4,49 @@ /// \file config_ver.h
/// \brief Library configuration file
+/// \details <tt>config_ver.h</tt> provides defines for library and compiler
+/// versions.
/// \details <tt>config.h</tt> was split into components in May 2019 to better
/// integrate with Autoconf and its feature tests. The splitting occurred so
/// users could continue to include <tt>config.h</tt> while allowing Autoconf
/// to write new <tt>config_asm.h</tt> and new <tt>config_cxx.h</tt> using
/// its feature tests.
+/// \note You should include <tt>config.h</tt> rather than <tt>config_ver.h</tt>
+/// directly.
/// \sa <A HREF="https://github.com/weidai11/cryptopp/issues/835">Issue 835</A>
/// \since Crypto++ 8.3
#ifndef CRYPTOPP_CONFIG_VERSION_H
#define CRYPTOPP_CONFIG_VERSION_H
-// Library version macro. Since this macro is in a header, it reflects
-// the version of the library the headers came from. It is not
-// necessarily the version of the library built as a shared object if
-// versions are inadvertently mixed and matched.
+/// \brief Library major version
+/// \details CRYPTOPP_MAJOR reflects the major version of the library the
+/// headers came from. It is not necessarily the version of the library built
+/// as a shared object if versions are inadvertently mixed and matched.
+/// \sa CRYPTOPP_VERSION, LibraryVersion(), HeaderVersion()
+/// \since Crypto++ 8.2
#define CRYPTOPP_MAJOR 8
+/// \brief Library minor version
+/// \details CRYPTOPP_MINOR reflects the minor version of the library the
+/// headers came from. It is not necessarily the version of the library built
+/// as a shared object if versions are inadvertently mixed and matched.
+/// \sa CRYPTOPP_VERSION, LibraryVersion(), HeaderVersion()
+/// \since Crypto++ 8.2
#define CRYPTOPP_MINOR 4
+/// \brief Library revision number
+/// \details CRYPTOPP_REVISION reflects the revision number of the library the
+/// headers came from. It is not necessarily the revision of the library built
+/// as a shared object if versions are inadvertently mixed and matched.
+/// \sa CRYPTOPP_VERSION, LibraryVersion(), HeaderVersion()
+/// \since Crypto++ 8.2
#define CRYPTOPP_REVISION 0
+
+/// \brief Full library version
+/// \details CRYPTOPP_VERSION reflects the version of the library the headers
+/// came from. It is not necessarily the version of the library built as a
+/// shared object if versions are inadvertently mixed and matched.
+/// \sa CRYPTOPP_MAJOR, CRYPTOPP_MINOR, CRYPTOPP_REVISION, LibraryVersion(), HeaderVersion()
+/// \since Crypto++ 5.6
#define CRYPTOPP_VERSION 840
// Compiler version macros
|