Improve comment formatting in dart-core, especially Comparable

sdk/lib/core/set.dart

 // Copyright (c) 2011, the Dart project authors.  Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
 part of dart.core;
 
 /**
  * A collection of objects in which each object can occur only once.
  *
  * That is, for each object of the element type, the object is either considered
  * to be in the set, or to _not_ be in the set.
  *
  * Set implementations may consider some elements indistinguishable. These
  * elements are treated as being the same for any operation on the set.
  *
- * The default `Set` implementation, [LinkedHashSet], considers objects
- * indistinguishable if they are equal with regard to [Object.operator==].
+ * The default [Set] implementation, [LinkedHashSet], considers objects
+ * indistinguishable if they are equal with regard to 
+ * operator [Object.==].
  *
  * Sets may be either ordered or unordered. [HashSet] is unordered and
  * doesn't guarantee anything about the order that elements are accessed in by
  * iteration. [LinkedHashSet] iterates in the insertion order of its elements.
  *
  * It is generally not allowed to modify the set (add or remove elements) while
  * an operation on the set is being performed, for example during a call to
  * [forEach] or [containsAll]. Nor is it allowed to modify the set while
- * iterating either the set itself or any `Iterable` that is backed by the set,
+ * iterating either the set itself or any [Iterable] that is backed by the set,
  * such as the ones returned by methods like [where] and [map].
  */
 abstract class Set<E> extends IterableBase<E> implements EfficientLength {
   /**
    * Creates an empty [Set].
    *
-   * The created `Set` is a [LinkedHashSet]. As such, it considers elements that
-   * are equal (using `==`) to be indistinguishable, and requires them to
+   * The created [Set] is a [LinkedHashSet]. As such, it considers elements that
+   * are equal (using [==]) to be indistinguishable, and requires them to
    * have a compatible [Object.hashCode] implementation.
    */
   factory Set() = LinkedHashSet<E>;
 
   /**
    * Creates an empty identity [Set].
    *
-   * The created `Set` is a [LinkedHashSet] that uses identity as equality
+   * The created [Set] is a [LinkedHashSet] that uses identity as equality
    * relation.
    */
   factory Set.identity() = LinkedHashSet<E>.identity;
 
   /**
    * Creates a [Set] that contains all elements of [other].
    *
-   * The created `Set` is a [LinkedHashSet]. As such, it considers elements that
-   * are equal (using `==`) to be undistinguishable, and requires them to
+   * The created [Set] is a [LinkedHashSet]. As such, it considers elements that
+   * are equal (using [==]) to be undistinguishable, and requires them to
    * have a compatible [Object.hashCode] implementation.
    */
   factory Set.from(Iterable<E> other) = LinkedHashSet<E>.from;
 
   /**
    * Returns true if [value] is in the set.
    */
   bool contains(Object value);
 
   /**
@@ skipping 52 matching lines @@
   void retainWhere(bool test(E element));
 
   /**
    * Returns whether this Set contains all the elements of [other].
    */
   bool containsAll(Iterable<Object> other);
 
   /**
    * Returns a new set which is the intersection between this set and [other].
    *
-   * That is, the returned set contains all the elements of this `Set` that
-   * are also elements of `other` according to `other.contains`.
+   * That is, the returned set contains all the elements of this [Set] that
+   * are also elements of [other] according to `other.contains`.
    */
   Set<E> intersection(Set<Object> other);
 
   /**
    * Returns a new set which contains all the elements of this set and [other].
    *
-   * That is, the returned set contains all the elements of this `Set` and
+   * That is, the returned set contains all the elements of this [Set] and
    * all the elements of [other].
    */
   Set<E> union(Set<E> other);
 
   /**
    * Returns a new set with the the elements of this that are not in [other].
    *
-   * That is, the returned set contains all the elements of this `Set` that
+   * That is, the returned set contains all the elements of this [Set] that
    * are not elements of [other] according to `other.contains`.
    */
   Set<E> difference(Set<E> other);
 
   /**
    * Removes all elements in the set.
    */
   void clear();
 }