Updated documentation

This commit is contained in:
Jeffrey Walton 2016-01-31 22:18:25 -05:00
parent 3a3fae8b8b
commit f71b9c4894

5
misc.h
View File

@ -151,13 +151,13 @@ struct CompileAssert
// ************** misc classes *************** // ************** misc classes ***************
#if !CRYPTOPP_DOXYGEN_PROCESSING //! \brief An Empty class
//! \brief An Emptry class
//! \details The Empty class can be used as a template parameter <tt>BASE</tt> when no base class exists. //! \details The Empty class can be used as a template parameter <tt>BASE</tt> when no base class exists.
class CRYPTOPP_DLL Empty class CRYPTOPP_DLL Empty
{ {
}; };
#if !CRYPTOPP_DOXYGEN_PROCESSING
template <class BASE1, class BASE2> template <class BASE1, class BASE2>
class CRYPTOPP_NO_VTABLE TwoBases : public BASE1, public BASE2 class CRYPTOPP_NO_VTABLE TwoBases : public BASE1, public BASE2
{ {
@ -2077,6 +2077,7 @@ T StringToWord(const std::string &str, ByteOrder order = BIG_ENDIAN_ORDER)
//! \details SafeShifter safely shifts values when undefined behavior could occur under C/C++ rules. //! \details SafeShifter safely shifts values when undefined behavior could occur under C/C++ rules.
//! The class behaves much like a saturating arithmetic class, clamping values rather than allowing //! The class behaves much like a saturating arithmetic class, clamping values rather than allowing
//! the compiler to remove undefined behavior. //! the compiler to remove undefined behavior.
//! \sa SafeShifter<true>, SafeShifter<false>
template <bool overflow> struct SafeShifter; template <bool overflow> struct SafeShifter;
//! \class SafeShifter<true> //! \class SafeShifter<true>