diff options
author | Jeffrey Walton <noloader@gmail.com> | 2020-12-25 00:40:54 -0500 |
---|---|---|
committer | Jeffrey Walton <noloader@gmail.com> | 2020-12-25 00:40:54 -0500 |
commit | b20bd360fceeeb63c8d211315cfc439ae709efa5 (patch) | |
tree | 2373d61849b7827c82cded6bd1dbce6702fe9da3 /misc.h | |
parent | 89dd418da35d246cad87b8a35de591f182f55992 (diff) | |
download | cryptopp-git-b20bd360fceeeb63c8d211315cfc439ae709efa5.tar.gz |
Update documentation
Diffstat (limited to 'misc.h')
-rw-r--r-- | misc.h | 11 |
1 files changed, 5 insertions, 6 deletions
@@ -1170,12 +1170,11 @@ inline T1 RoundUpToMultipleOf(const T1 &n, const T2 &m) /// \brief Returns the minimum alignment requirements of a type
/// \tparam T class or type
/// \return the minimum alignment requirements of <tt>T</tt>, in bytes
-/// \details Internally the function calls C++11's <tt>alignof</tt> if available. If not
-/// available, then the function uses compiler specific extensions such as
-/// <tt>__alignof</tt> and <tt>_alignof_</tt>. If an extension is not available, then
-/// the function uses <tt>__BIGGEST_ALIGNMENT__</tt> if <tt>__BIGGEST_ALIGNMENT__</tt>
-/// is smaller than <tt>sizeof(T)</tt>. <tt>sizeof(T)</tt> is used if all others are
-/// not available.
+/// \details Internally the function calls C++11's <tt>alignof</tt> if
+/// available. If not available, then the function uses compiler
+/// specific extensions such as <tt>__alignof</tt> and <tt>_alignof_</tt>.
+/// If an extension is not available, then the function uses
+/// <tt>sizeof(T)</tt>.
template <class T>
inline unsigned int GetAlignmentOf()
{
|