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_cxx.h | |
parent | 446aef2e5ea823c174df0037a8844e715283226d (diff) | |
download | cryptopp-git-8f1746790eee65207f127674a883a16fd6179d32.tar.gz |
Update documentation
Diffstat (limited to 'config_cxx.h')
-rw-r--r-- | config_cxx.h | 5 |
1 files changed, 5 insertions, 0 deletions
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
|