diff options
| -rw-r--r-- | config_align.h | 4 | ||||
| -rw-r--r-- | config_asm.h | 5 | ||||
| -rw-r--r-- | config_cpu.h | 4 | ||||
| -rw-r--r-- | config_cxx.h | 5 | ||||
| -rw-r--r-- | config_dll.h | 4 | ||||
| -rw-r--r-- | config_int.h | 3 | ||||
| -rw-r--r-- | config_misc.h | 3 | ||||
| -rw-r--r-- | config_ns.h | 4 | ||||
| -rw-r--r-- | config_os.h | 4 | ||||
| -rw-r--r-- | config_ver.h | 33 |
10 files changed, 65 insertions, 4 deletions
diff --git a/config_align.h b/config_align.h index 5b02e291..b0ff9889 100644 --- a/config_align.h +++ b/config_align.h @@ -4,11 +4,15 @@ /// \file config_align.h
/// \brief Library configuration file
+/// \details <tt>config_align.h</tt> provides defines for aligned memory
+/// allocations.
/// \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_align.h</tt>
+/// directly.
/// \sa <A HREF="https://github.com/weidai11/cryptopp/issues/835">Issue 835</A>
/// \since Crypto++ 8.3
diff --git a/config_asm.h b/config_asm.h index c94326ab..8e7f68ae 100644 --- a/config_asm.h +++ b/config_asm.h @@ -4,11 +4,16 @@ /// \file config_asm.h
/// \brief Library configuration file
+/// \details <tt>config_asm.h</tt> provides defines for instruction set
+/// architectures
+/// and inline assembly.
/// \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_asm.h</tt>
+/// directly.
/// \sa <A HREF="https://github.com/weidai11/cryptopp/issues/835">Issue 835</A>
/// \since Crypto++ 8.3
diff --git a/config_cpu.h b/config_cpu.h index 2d593977..e65e1623 100644 --- a/config_cpu.h +++ b/config_cpu.h @@ -4,11 +4,15 @@ /// \file config_cpu.h
/// \brief Library configuration file
+/// \details <tt>config_cpu.h</tt> provides defines for the cpu and machine
+/// architecture.
/// \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_cpu.h</tt>
+/// directly.
/// \sa <A HREF="https://github.com/weidai11/cryptopp/issues/835">Issue 835</A>
/// <A HREF="https://sourceforge.net/p/predef/wiki/Architectures/">Sourceforge
/// Pre-defined Compiler Macros</A>
diff --git a/config_cxx.h b/config_cxx.h index bcf1fc9c..49555a45 100644 --- a/config_cxx.h +++ b/config_cxx.h @@ -4,11 +4,16 @@ /// \file config_cxx.h
/// \brief Library configuration file
+/// \details <tt>config_cxx.h</tt> provides defines for C++ language and
+/// runtime library
+/// features.
/// \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_cxx.h</tt>
+/// directly.
/// \sa <A HREF="https://github.com/weidai11/cryptopp/issues/835">Issue 835</A>
/// \since Crypto++ 8.3
diff --git a/config_dll.h b/config_dll.h index b33ad757..5ded7853 100644 --- a/config_dll.h +++ b/config_dll.h @@ -4,11 +4,15 @@ /// \file config_dll.h
/// \brief Library configuration file
+/// \details <tt>config_dll.h</tt> provides defines for shared objects and
+/// dynamic libraries.
/// \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_dll.h</tt>
+/// directly.
/// \sa <A HREF="https://github.com/weidai11/cryptopp/issues/835">Issue 835</A>
/// \since Crypto++ 8.3
diff --git a/config_int.h b/config_int.h index 74ddfed9..1fd72574 100644 --- a/config_int.h +++ b/config_int.h @@ -4,11 +4,14 @@ /// \file config_int.h
/// \brief Library configuration file
+/// \details <tt>config_int.h</tt> provides defines and typedefs for integers.
/// \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_int.h</tt>
+/// directly.
/// \sa <A HREF="https://github.com/weidai11/cryptopp/issues/835">Issue 835</A>
/// \since Crypto++ 8.3
diff --git a/config_misc.h b/config_misc.h index 6530318c..bc5deeeb 100644 --- a/config_misc.h +++ b/config_misc.h @@ -4,11 +4,14 @@ /// \file config_misc.h
/// \brief Library configuration file
+/// \details <tt>config_misc.h</tt> provides miscellaneous defines.
/// \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_misc.h</tt>
+/// directly.
/// \sa <A HREF="https://github.com/weidai11/cryptopp/issues/835">Issue 835</A>
/// \since Crypto++ 8.3
diff --git a/config_ns.h b/config_ns.h index 2bbb5823..d5d8489b 100644 --- a/config_ns.h +++ b/config_ns.h @@ -4,11 +4,15 @@ /// \file config_ns.h
/// \brief Library configuration file
+/// \details <tt>config_ns.h</tt> provides defines for C++ and library
+/// namespaces.
/// \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_ns.h</tt>
+/// directly.
/// \sa <A HREF="https://github.com/weidai11/cryptopp/issues/835">Issue 835</A>
/// \since Crypto++ 8.3
diff --git a/config_os.h b/config_os.h index 32655488..3f2a9880 100644 --- a/config_os.h +++ b/config_os.h @@ -4,11 +4,15 @@ /// \file config_os.h
/// \brief Library configuration file
+/// \details <tt>config_os.h</tt> provides defines for platforms and operating
+/// systems.
/// \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_os.h</tt>
+/// directly.
/// \sa <A HREF="https://github.com/weidai11/cryptopp/issues/835">Issue 835</A>
/// \since Crypto++ 8.3
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
|