summaryrefslogtreecommitdiff
path: root/config_int.h
diff options
context:
space:
mode:
Diffstat (limited to 'config_int.h')
-rw-r--r--config_int.h3
1 files changed, 3 insertions, 0 deletions
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