DocStrings
Related Doc:
package util
Test two objects for inequality.
Test two objects for inequality.
true if !(this == that), false otherwise.
Equivalent to x.hashCode except for boxed numeric types and null.
Equivalent to x.hashCode except for boxed numeric types and null.
For numerics, it returns a hash value which is consistent
with value equality: if two value type instances compare
as true, then ## will produce the same hash value for each
of them.
For null returns a hashcode where null.hashCode throws a
NullPointerException.
a hash value consistent with ==
The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).
The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).
true if the receiver object is equivalent to the argument; false otherwise.
Cast the receiver object to be of type T0.
Cast the receiver object to be of type T0.
Note that the success of a cast at runtime is modulo Scala's erasure semantics.
Therefore the expression 1.asInstanceOf[String] will throw a ClassCastException at
runtime, while the expression List(1).asInstanceOf[List[String]] will not.
In the latter example, because the type argument is erased as part of compilation it is
not possible to check whether the contents of the list are of the requested type.
the receiver object.
ClassCastException if the receiver object is not an instance of the erasure of type T0.
Cleanup section text
Create a copy of the receiver object.
Create a copy of the receiver object.
The default implementation of the clone method is platform dependent.
a copy of the receiver object.
not specified by SLS as a member of AnyRef
Tests whether the argument (that) is a reference to the receiver object (this).
Tests whether the argument (that) is a reference to the receiver object (this).
The eq method implements an equivalence relation on
non-null instances of AnyRef, and has three additional properties:
x and y of type AnyRef, multiple invocations of
x.eq(y) consistently returns true or consistently returns false.x of type AnyRef, x.eq(null) and null.eq(x) returns false.null.eq(null) returns true. When overriding the equals or hashCode methods, it is important to ensure that their behavior is
consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they
should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).
true if the argument is a reference to the receiver object; false otherwise.
The equality method for reference types.
Extract the section parameter
Extract the section tag, treating the section tag as an identifier
Extract the section text, except for the tag and comment newlines
Called by the garbage collector on the receiver object when there are no more references to the object.
Called by the garbage collector on the receiver object when there are no more references to the object.
The details of when and if the finalize method is invoked, as
well as the interaction between finalize and non-local returns
and exceptions, are all platform dependent.
not specified by SLS as a member of AnyRef
Return first index following start and starting a line (i.e.
Return first index following start and starting a line (i.e. after skipLineLead)
which satisfies predicate p.
Returns first index following start and starting a line (i.e.
Returns first index following start and starting a line (i.e. after skipLineLead) or starting the comment
which satisfies predicate p.
A representation that corresponds to the dynamic class of the receiver object.
A representation that corresponds to the dynamic class of the receiver object.
The nature of the representation is platform dependent.
a representation that corresponds to the dynamic class of the receiver object.
not specified by SLS as a member of AnyRef
Optionally start and end index of return section in str, or None
if str does not have a @group.
The hashCode method for reference types.
Test whether the dynamic type of the receiver object is T0.
Test whether the dynamic type of the receiver object is T0.
Note that the result of the test is modulo Scala's erasure semantics.
Therefore the expression 1.isInstanceOf[String] will return false, while the
expression List(1).isInstanceOf[List[String]] will return true.
In the latter example, because the type argument is erased as part of compilation it is
not possible to check whether the contents of the list are of the specified type.
true if the receiver object is an instance of erasure of type T0; false otherwise.
Merge the inheritdoc sections, as they never make sense on their own
Merge sections following an usecase into the usecase comment, so they can override the parent symbol's sections
Equivalent to !(this eq that).
Equivalent to !(this eq that).
true if the argument is not a reference to the receiver object; false otherwise.
Wakes up a single thread that is waiting on the receiver object's monitor.
Wakes up a single thread that is waiting on the receiver object's monitor.
not specified by SLS as a member of AnyRef
Wakes up all threads that are waiting on the receiver object's monitor.
Wakes up all threads that are waiting on the receiver object's monitor.
not specified by SLS as a member of AnyRef
A map from parameter names to start/end indices describing all parameter
sections in str tagged with tag, where sections is the index of str.
Optionally start and end index of return section in str, or None
if str does not have a @return.
A map from the section tag to section parameters
Returns index of string str following start skipping
sequence of identifier characters.
Returns index of string str after start skipping longest
sequence of space and tab characters, possibly also containing
a single * character or the /** sequence.
Returns index of string str following start skipping
sequence of identifier characters.
Skips to next occurrence of \n or to the position after the /** sequence following index start.
Returns index following variable, or start index if no variable was recognized
Returns index of string str following start skipping longest
sequence of whitespace characters characters (but no newlines)
The first start tag of a list of tag intervals, or the end of the whole comment string - 2 if list is empty
Does interval iv start with given tag?
Produces a string index, which is a list of sections, i.e
pairs of start/end positions of all tagged sections in the string.
Produces a string index, which is a list of sections, i.e
pairs of start/end positions of all tagged sections in the string.
Every section starts with an at sign and extends to the next at sign,
or to the end of the comment string, but excluding the final two
characters which terminate the comment.
Also take usecases into account - they need to expand until the next usecase or the end of the string, as they might include other sections of their own
Creates a String representation of this object.
Creates a String representation of this object. The default representation is platform dependent. On the java platform it is the concatenation of the class name, "@", and the object's hashcode in hexadecimal.
a String representation of the object.
Extracts variable name from a string, stripping any pair of surrounding braces
Utility methods for doc comment strings