From 20859263f2a2cf85464b333b9842bb31c020ee5e Mon Sep 17 00:00:00 2001
From: Paul Phillips <paulp@improving.org>
Date: Mon, 15 Aug 2011 20:48:25 +0000
Subject: Removing the code which has been deprecated sin...

Removing the code which has been deprecated since 2.8.0. Contributed by
Simon Ochsenreither, although deleting code is such fun one hesitates to
call it a contribution. Still, we will. Closes SI-4860, no review.
---
 src/library/scala/Boolean.scala | 76 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 76 insertions(+)

(limited to 'src/library/scala/Boolean.scala')

diff --git a/src/library/scala/Boolean.scala b/src/library/scala/Boolean.scala
index f77bdd2ea0..dd5439d537 100755
--- a/src/library/scala/Boolean.scala
+++ b/src/library/scala/Boolean.scala
@@ -17,17 +17,93 @@ package scala
  *  which provides useful non-primitive operations.
  */
 final class Boolean extends AnyVal {
+  /**
+   * Negates a Boolean expression.
+   *
+   * - `!a` results in `false` if and only if `a` evaluates to `true` and
+   * - `!a` results in `true` if and only if `a` evaluates to `false`.
+   *
+   * @return the negated expression
+   */
   def unary_! : Boolean = sys.error("stub")
 
+  /**
+    * Compares two Boolean expressions and returns `true` if they evaluate to the same value.
+    *
+    * `a == b` returns `true` if and only if
+    *  - `a` and `b` are `true` or
+    *  - `a` and `b` are `false`.
+    */
   def ==(x: Boolean): Boolean = sys.error("stub")
+
+  /**
+    * Compares two Boolean expressions and returns `true` if they evaluate to a different value.
+    *
+    * `a != b` returns `true` if and only if
+    *  - `a` is `true` and `b` is `false` or
+    *  - `a` is `false` and `b` is `true`.
+    */
   def !=(x: Boolean): Boolean = sys.error("stub")
+
+  /**
+    * Compares two Boolean expressions and returns `true` if one or both of them evaluate to true.
+    *
+    * `a || b` returns `true` if and only if
+    *  - `a` is `true` or
+    *  - `b` is `true` or
+    *  - `a` and `b` are `true`.
+    *
+    * @note This method uses 'short-circuit' evaluation and
+    *       behaves as if it was declared as `def ||(x: => Boolean): Boolean`.
+    *       If `a` evaluates to `true`, `true` is returned without evaluating `b`.
+    */
   def ||(x: Boolean): Boolean = sys.error("stub")
+
+  /**
+    * Compares two Boolean expressions and returns `true` if both of them evaluate to true.
+    *
+    * `a && b` returns `true` if and only if
+    *  - `a` and `b` are `true`.
+    *
+    * @note This method uses 'short-circuit' evaluation and
+    *       behaves as if it was declared as `def &&(x: => Boolean): Boolean`.
+    *       If `a` evaluates to `false`, `false` is returned without evaluating `b`.
+    */
   def &&(x: Boolean): Boolean = sys.error("stub")
+
   // Compiler won't build with these seemingly more accurate signatures
   // def ||(x: => Boolean): Boolean = sys.error("stub")
   // def &&(x: => Boolean): Boolean = sys.error("stub")
+
+  /**
+    * Compares two Boolean expressions and returns `true` if one or both of them evaluate to true.
+    *
+    * `a | b` returns `true` if and only if
+    *  - `a` is `true` or
+    *  - `b` is `true` or
+    *  - `a` and `b` are `true`.
+    *
+    * @note This method evaluates both `a` and `b`, even if the result is already determined after evaluating `a`.
+    */
   def |(x: Boolean): Boolean  = sys.error("stub")
+
+  /**
+    * Compares two Boolean expressions and returns `true` if both of them evaluate to true.
+    *
+    * `a & b` returns `true` if and only if
+    *  - `a` and `b` are `true`.
+    *
+    * @note This method evaluates both `a` and `b`, even if the result is already determined after evaluating `a`.
+    */
   def &(x: Boolean): Boolean  = sys.error("stub")
+
+  /**
+    * Compares two Boolean expressions and returns `true` if they evaluate to a different value.
+    *
+    * `a ^ b` returns `true` if and only if
+    *  - `a` is `true` and `b` is `false` or
+    *  - `a` is `false` and `b` is `true`.
+    */
   def ^(x: Boolean): Boolean  = sys.error("stub")
 
   def getClass(): Class[Boolean] = sys.error("stub")
-- 
cgit v1.2.3