Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@noloader
noloader committed Jun 23, 2023
1 parent 7e63138 commit a58a783
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions misc.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -706,10 +706,10 @@ template <class T1, class T2> inline const T1 UnsignedMin(const T1& a, const T2&
/// \tparam T2 class or type
/// \param from the first value
/// \param to the second value
/// \return true if its safe to convert \p from to \p to, false otherwise.
/// \return true if its safe to convert from \p from to \p to, false otherwise.
/// \details if the function returns true, then it is safe to use \p to. If the function returns false,
/// then \p to is undefined and should not be used.
/// \note: for integral conversions, a template specialization should be provided. The specialization
/// \note for integral conversions, a template specialization should be provided. The specialization
/// will perform more efficiently, and avoid warnings for truncation and sign compares.
template <class T1, class T2>
inline bool SafeConvert(T1 from, T2 &to)
Expand All @@ -723,7 +723,7 @@ inline bool SafeConvert(T1 from, T2 &to)
/// \brief Perform a conversion from \p from to \p to
/// \param from the first value
/// \param to the second value
/// \return true if its safe to convert \p from to \p to, false otherwise.
/// \return true if its safe to convert from \p from to \p to, false otherwise.
/// \details if the function returns true, then it is safe to use \p to. If the function returns false,
/// then \p to is undefined and should not be used.
/// \since Crypto++ 8.7
Expand All @@ -737,7 +737,7 @@ inline bool SafeConvert(word32 from, word64 &to)
/// \brief Perform a conversion from \p from to \p to
/// \param from the first value
/// \param to the second value
/// \return true if its safe to convert \p from to \p to, false otherwise.
/// \return true if its safe to convert from \p from to \p to, false otherwise.
/// \details if the function returns true, then it is safe to use \p to. If the function returns false,
/// then \p to is undefined and should not be used.
/// \since Crypto++ 8.7
Expand All @@ -753,7 +753,7 @@ inline bool SafeConvert(word64 from, word32 &to)
/// \brief Perform a conversion from \p from to \p to
/// \param from the first value
/// \param to the second value
/// \return true if its safe to convert \p from to \p to, false otherwise.
/// \return true if its safe to convert from \p from to \p to, false otherwise.
/// \details if the function returns true, then it is safe to use \p to. If the function returns false,
/// then \p to is undefined and should not be used.
/// \since Crypto++ 8.7
Expand All @@ -769,7 +769,7 @@ inline bool SafeConvert(word64 from, sword64 &to)
/// \brief Perform a conversion from \p from to \p to
/// \param from the first value
/// \param to the second value
/// \return true if its safe to convert \p from to \p to, false otherwise.
/// \return true if its safe to convert from \p from to \p to, false otherwise.
/// \details if the function returns true, then it is safe to use \p to. If the function returns false,
/// then \p to is undefined and should not be used.
/// \since Crypto++ 8.7
Expand All @@ -785,7 +785,7 @@ inline bool SafeConvert(sword64 from, word64 &to)
/// \brief Perform a conversion from \p from to \p to
/// \param from the first value
/// \param to the second value
/// \return true if its safe to convert \p from to \p to, false otherwise.
/// \return true if its safe to convert from \p from to \p to, false otherwise.
/// \details if the function returns true, then it is safe to use \p to. If the function returns false,
/// then \p to is undefined and should not be used.
/// \since Crypto++ 8.7
Expand All @@ -801,7 +801,7 @@ inline bool SafeConvert(word64 from, sword32 &to)
/// \brief Perform a conversion from \p from to \p to
/// \param from the first value
/// \param to the second value
/// \return true if its safe to convert \p from to \p to, false otherwise.
/// \return true if its safe to convert from \p from to \p to, false otherwise.
/// \details if the function returns true, then it is safe to use \p to. If the function returns false,
/// then \p to is undefined and should not be used.
/// \since Crypto++ 8.7
Expand All @@ -817,7 +817,7 @@ inline bool SafeConvert(sword32 from, word64 &to)
/// \brief Perform a conversion from \p from to \p to
/// \param from the first value
/// \param to the second value
/// \return true if its safe to convert \p from to \p to, false otherwise.
/// \return true if its safe to convert from \p from to \p to, false otherwise.
/// \details if the function returns true, then it is safe to use \p to. If the function returns false,
/// then \p to is undefined and should not be used.
/// \since Crypto++ 8.7
Expand All @@ -833,7 +833,7 @@ inline bool SafeConvert(word32 from, sword32 &to)
/// \brief Perform a conversion from \p from to \p to
/// \param from the first value
/// \param to the second value
/// \return true if its safe to convert \p from to \p to, false otherwise.
/// \return true if its safe to convert from \p from to \p to, false otherwise.
/// \details if the function returns true, then it is safe to use \p to. If the function returns false,
/// then \p to is undefined and should not be used.
/// \since Crypto++ 8.7
Expand Down

0 comments on commit a58a783

Please sign in to comment.