summaryrefslogtreecommitdiff
path: root/integer.h
diff options
context:
space:
mode:
authorJeffrey Walton <noloader@gmail.com>2021-09-25 15:43:54 -0400
committerJeffrey Walton <noloader@gmail.com>2021-09-25 15:43:54 -0400
commit72237f912a7587404d0cbf7586aa0a0e81ee15e7 (patch)
treed1b1ad95fe565f05e31569fec4eec66217db162e /integer.h
parentd6322a8a54fbb22f35949c0d959354091746811a (diff)
downloadcryptopp-git-72237f912a7587404d0cbf7586aa0a0e81ee15e7.tar.gz
Update documentation
Diffstat (limited to 'integer.h')
-rw-r--r--integer.h16
1 files changed, 8 insertions, 8 deletions
diff --git a/integer.h b/integer.h
index e69b9339..db9dc6e8 100644
--- a/integer.h
+++ b/integer.h
@@ -299,7 +299,7 @@ public:
/// \name ACCESSORS
//@{
/// \brief Determines if the Integer is convertable to Long
- /// \return true if *this can be represented as a signed long
+ /// \return true if <tt>*this</tt> can be represented as a signed long
/// \sa ConvertToLong()
bool IsConvertableToLong() const;
/// \brief Convert the Integer to Long
@@ -327,7 +327,7 @@ public:
/// \return the i-th byte
byte GetByte(size_t i) const;
/// \brief Provides the low order bits of the Integer
- /// \return n lowest bits of *this >> i
+ /// \return n lowest bits of <tt>*this >> i</tt>
lword GetBits(size_t i, size_t n) const;
/// \brief Determines if the Integer is 0
@@ -405,8 +405,8 @@ public:
/// \brief Bitwise AND Assignment
/// \param t the other Integer
- /// \return the result of *this & t
- /// \details operator&=() performs a bitwise AND on *this. Missing bits are truncated
+ /// \return the result of <tt>*this & t</tt>
+ /// \details operator&=() performs a bitwise AND on <tt>*this</tt>. Missing bits are truncated
/// at the most significant bit positions, so the result is as small as the
/// smaller of the operands.
/// \details Internally, Crypto++ uses a sign-magnitude representation. The library
@@ -417,8 +417,8 @@ public:
Integer& operator&=(const Integer& t);
/// \brief Bitwise OR Assignment
/// \param t the second Integer
- /// \return the result of *this | t
- /// \details operator|=() performs a bitwise OR on *this. Missing bits are shifted in
+ /// \return the result of <tt>*this | t</tt>
+ /// \details operator|=() performs a bitwise OR on <tt>*this</tt>. Missing bits are shifted in
/// at the most significant bit positions, so the result is as large as the
/// larger of the operands.
/// \details Internally, Crypto++ uses a sign-magnitude representation. The library
@@ -429,8 +429,8 @@ public:
Integer& operator|=(const Integer& t);
/// \brief Bitwise XOR Assignment
/// \param t the other Integer
- /// \return the result of *this ^ t
- /// \details operator^=() performs a bitwise XOR on *this. Missing bits are shifted
+ /// \return the result of <tt>*this ^ t</tt>
+ /// \details operator^=() performs a bitwise XOR on <tt>*this</tt>. Missing bits are shifted
/// in at the most significant bit positions, so the result is as large as the
/// larger of the operands.
/// \details Internally, Crypto++ uses a sign-magnitude representation. The library