fix header comment
[haskell-directory.git] / Data / Bits.hs
index d33f7ee..1c9cc4c 100644 (file)
@@ -9,11 +9,11 @@
 -- Stability   :  experimental
 -- Portability :  portable
 --
---  This module defines bitwise operations for signed and unsigned
---  integers.  Instances of the class 'Bits' for the 'Int' and
---  'Integer' types are available from this module, and instances for
---  explicitly sized integral types are available from the
---  "Data.Int" and "Data.Word" modules.
+-- This module defines bitwise operations for signed and unsigned
+-- integers.  Instances of the class 'Bits' for the 'Int' and
+-- 'Integer' types are available from this module, and instances for
+-- explicitly sized integral types are available from the
+-- "Data.Int" and "Data.Word" modules.
 --
 -----------------------------------------------------------------------------
 
@@ -66,6 +66,10 @@ The 'Bits' class defines bitwise operations over integral types.
 
 * Bits are numbered from 0 with bit 0 being the least
   significant bit.
+
+Minimal complete definition: '.&.', '.|.', 'xor', 'complement',
+('shift' or ('shiftL' and 'shiftR')), ('rotate' or ('rotateL' and 'rotateR')),
+'bitSize' and 'isSigned'.
 -}
 class Num a => Bits a where
     -- | Bitwise \"and\"