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