diff options
Diffstat (limited to 'config_os.h')
| -rw-r--r-- | config_os.h | 4 |
1 files changed, 4 insertions, 0 deletions
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
|