From 18644419b50b2b14a24456e0fcdb210f231ee317 Mon Sep 17 00:00:00 2001
From: Tuowen Zhao <ztuowen@gmail.com>
Date: Sun, 18 Sep 2016 15:16:52 -0600
Subject: doc updated for code_gen

---
 omegalib/omega/include/basic/BoolSet.h | 18 +++++++++++-------
 1 file changed, 11 insertions(+), 7 deletions(-)

(limited to 'omegalib/omega/include/basic/BoolSet.h')

diff --git a/omegalib/omega/include/basic/BoolSet.h b/omegalib/omega/include/basic/BoolSet.h
index dc9ef83..a78af2e 100755
--- a/omegalib/omega/include/basic/BoolSet.h
+++ b/omegalib/omega/include/basic/BoolSet.h
@@ -25,7 +25,8 @@
 #include <iterator>
 
 namespace omega {
-  
+
+    //!  BoolSet class, used as a set of integers from 0 to n-1 where n is a very small integer.
 template<typename T = unsigned int>
 class BoolSet {
 protected:
@@ -50,17 +51,20 @@ public:
   BoolSet<T> &operator|=(const BoolSet<T> &); 
   BoolSet<T> &operator&=(const BoolSet<T> &); 
   BoolSet<T> &operator-=(const BoolSet<T> &); 
-  
-  template<typename TT> friend BoolSet<TT> operator|(const BoolSet<TT> &, const BoolSet<TT> &);  // union
-  template<typename TT> friend BoolSet<TT> operator&(const BoolSet<TT> &, const BoolSet<TT> &);  // intersection
-  template<typename TT> friend BoolSet<TT> operator-(const BoolSet<TT> &, const BoolSet<TT> &);  // difference  
-  template<typename TT> friend BoolSet<TT> operator~(const BoolSet<TT> &);                       // complement
+
+  //! union
+  template<typename TT> friend BoolSet<TT> operator|(const BoolSet<TT> &, const BoolSet<TT> &);
+  //! intersection
+  template<typename TT> friend BoolSet<TT> operator&(const BoolSet<TT> &, const BoolSet<TT> &);
+  //! difference
+  template<typename TT> friend BoolSet<TT> operator-(const BoolSet<TT> &, const BoolSet<TT> &);
+  //! complement
+  template<typename TT> friend BoolSet<TT> operator~(const BoolSet<TT> &);                 
   template<typename TT> friend bool operator==(const BoolSet<TT> &, const BoolSet<TT> &); 
   template<typename TT> friend bool operator!=(const BoolSet<TT> &, const BoolSet<TT> &); 
   template<typename TT> friend std::ostream& operator<<(std::ostream &, const BoolSet<TT> &);
   template<typename TT> friend bool operator<(const BoolSet<TT> &, const BoolSet<TT> &);
 
-// iterator related
 public:
   class iterator;
   class const_iterator;
-- 
cgit v1.2.3-70-g09d2