Subject: [Boost-commit] svn:boost r61022 - sandbox/xint/boost/xint
From: pbristow_at_[hidden]
Date: 2010-04-03 13:52:20
Author: pbristow
Date: 2010-04-03 13:52:19 EDT (Sat, 03 Apr 2010)
New Revision: 61022
URL: http://svn.boost.org/trac/boost/changeset/61022
Log:
Added a few sample item doxygen descriptors to class integer.
Text files modified:
sandbox/xint/boost/xint/xint.hpp | 21 ++++++++++++---------
1 files changed, 12 insertions(+), 9 deletions(-)
Modified: sandbox/xint/boost/xint/xint.hpp
==============================================================================
--- sandbox/xint/boost/xint/xint.hpp (original)
+++ sandbox/xint/boost/xint/xint.hpp 2010-04-03 13:52:19 EDT (Sat, 03 Apr 2010)
@@ -114,9 +114,12 @@
// The integer class
class integer {
+ //! \class integer \brief The extended integer class.
+ //! \details TODO more info on the integer class???
public:
- integer();
- integer(const integer& b);
+ integer(); //!< Constructs a default integer, value zero.
+ integer(const integer& b); //!< Copy constructs a integer from another integer.
+ //!< (Can throw std::overflow_error if not enough memory to construct a new integer).
template <typename T> integer(const T& n,
typename boost::enable_if<boost::is_integral<T> >::type* = 0,
@@ -125,16 +128,16 @@
typename boost::enable_if<boost::is_integral<T> >::type* = 0,
typename boost::enable_if<boost::is_unsigned<T> >::type* = 0);
- explicit integer(const std::string& str, size_t base=10);
- explicit integer(const not_a_number&);
+ explicit integer(const std::string& str, size_t base=10); //!< Constructs an integer from a std::string of decimal digits.
+ explicit integer(const not_a_number&); //!< Constructs an integer with value NaN.
~integer();
- bool odd() const;
- bool even() const;
- int sign() const;
- bool nan() const; // Tests for Not-a-Number
+ bool odd() const; //!< \returns true if extended integer is odd.
+ bool even() const; //!< \returns true if extended integer is even.
+ int sign() const; //!< \returns -1 if extended integer is < 0.
+ bool nan() const; //!< \returns true if extended integer is Not-a-Number.
- size_t hex_digits() const;
+ size_t hex_digits() const; //!< \returns the number of hex digits to show the integer.
integer& operator=(const integer &c);