object DocStrings
- Alphabetic
- By Inheritance
- DocStrings
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Value Members
-
final
def
!=(arg0: Any): Boolean
Test two objects for inequality.
Test two objects for inequality.
- returns
true
if !(this == that), false otherwise.
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
Equivalent to
x.hashCode
except for boxed numeric types andnull
.Equivalent to
x.hashCode
except for boxed numeric types andnull
. 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. Fornull
returns a hashcode wherenull.hashCode
throws aNullPointerException
.- returns
a hash value consistent with ==
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
The expression
x == that
is equivalent toif (x eq null) that eq null else x.equals(that)
.The expression
x == that
is equivalent toif (x eq null) that eq null else x.equals(that)
.- returns
true
if the receiver object is equivalent to the argument;false
otherwise.
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
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 aClassCastException
at runtime, while the expressionList(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.- returns
the receiver object.
- Definition Classes
- Any
- Exceptions thrown
ClassCastException
if the receiver object is not an instance of the erasure of typeT0
.
-
def
cleanupSectionText(str: String): String
Cleanup section text
-
def
clone(): AnyRef
Create a copy of the receiver object.
Create a copy of the receiver object.
The default implementation of the
clone
method is platform dependent.- returns
a copy of the receiver object.
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
- Note
not specified by SLS as a member of AnyRef
-
final
def
eq(arg0: AnyRef): Boolean
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 ofAnyRef
, and has three additional properties:- It is consistent: for any non-null instances
x
andy
of typeAnyRef
, multiple invocations ofx.eq(y)
consistently returnstrue
or consistently returnsfalse
. - For any non-null instance
x
of typeAnyRef
,x.eq(null)
andnull.eq(x)
returnsfalse
. null.eq(null)
returnstrue
.
When overriding the
equals
orhashCode
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
).- returns
true
if the argument is a reference to the receiver object;false
otherwise.
- Definition Classes
- AnyRef
- It is consistent: for any non-null instances
-
def
equals(arg0: Any): Boolean
The equality method for reference types.
-
def
extractSectionParam(str: String, section: (Int, Int)): String
Extract the section parameter
-
def
extractSectionTag(str: String, section: (Int, Int)): String
Extract the section tag, treating the section tag as an identifier
-
def
extractSectionText(str: String, section: (Int, Int)): (Int, Int)
Extract the section text, except for the tag and comment newlines
-
def
finalize(): Unit
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 betweenfinalize
and non-local returns and exceptions, are all platform dependent.- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
- Note
not specified by SLS as a member of AnyRef
-
def
findAll(str: String, start: Int)(p: (Int) ⇒ Boolean): List[Int]
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 predicatep
. -
def
findNext(str: String, start: Int)(p: (Int) ⇒ Boolean): Int
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 predicatep
. -
final
def
getClass(): Class[_]
Returns the runtime class representation of the object.
Returns the runtime class representation of the object.
- returns
a class object corresponding to the runtime type of the receiver.
- Definition Classes
- AnyRef → Any
-
def
groupDoc(str: String, sections: List[(Int, Int)]): Option[(Int, Int)]
Optionally start and end index of return section in
str
, orNone
ifstr
does not have a @group. -
def
hashCode(): Int
The hashCode method for reference types.
-
final
def
isInstanceOf[T0]: Boolean
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 returnfalse
, while the expressionList(1).isInstanceOf[List[String]]
will returntrue
. 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.- returns
true
if the receiver object is an instance of erasure of typeT0
;false
otherwise.
- Definition Classes
- Any
-
def
mergeInheritdocSections(str: String, idxs: List[Int]): List[Int]
Merge the inheritdoc sections, as they never make sense on their own
-
def
mergeUsecaseSections(str: String, idxs: List[Int]): List[Int]
Merge sections following an usecase into the usecase comment, so they can override the parent symbol's sections
-
final
def
ne(arg0: AnyRef): Boolean
Equivalent to
!(this eq that)
.Equivalent to
!(this eq that)
.- returns
true
if the argument is not a reference to the receiver object;false
otherwise.
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
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.
- Definition Classes
- AnyRef
- Note
not specified by SLS as a member of AnyRef
-
final
def
notifyAll(): Unit
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.
- Definition Classes
- AnyRef
- Note
not specified by SLS as a member of AnyRef
-
def
paramDocs(str: String, tag: String, sections: List[(Int, Int)]): Map[String, (Int, Int)]
A map from parameter names to start/end indices describing all parameter sections in
str
tagged withtag
, wheresections
is the index ofstr
. -
def
returnDoc(str: String, sections: List[(Int, Int)]): Option[(Int, Int)]
Optionally start and end index of return section in
str
, orNone
ifstr
does not have a @return. -
def
sectionTagMap(str: String, sections: List[(Int, Int)]): Map[String, (Int, Int)]
A map from the section tag to section parameters
-
def
skipIdent(str: String, start: Int): Int
Returns index of string
str
followingstart
skipping sequence of identifier characters. -
def
skipLineLead(str: String, start: Int): Int
Returns index of string
str
afterstart
skipping longest sequence of space and tab characters, possibly also containing a single*
character or the/
**
sequence. -
def
skipTag(str: String, start: Int): Int
Returns index of string
str
followingstart
skipping sequence of identifier characters. -
def
skipToEol(str: String, start: Int): Int
Skips to next occurrence of
\n
or to the position after the/
**
sequence following indexstart
. -
def
skipVariable(str: String, start: Int): Int
Returns index following variable, or start index if no variable was recognized
-
def
skipWhitespace(str: String, start: Int): Int
Returns index of string
str
followingstart
skipping longest sequence of whitespace characters characters (but no newlines) -
def
startTag(str: String, sections: List[(Int, Int)]): Int
The first start tag of a list of tag intervals, or the end of the whole comment string - 2 if list is empty
- def startsWithTag(str: String, start: Int, tag: String): Boolean
-
def
startsWithTag(str: String, section: (Int, Int), tag: String): Boolean
Does interval
iv
start with giventag
? -
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
tagIndex(str: String, p: (Int) ⇒ Boolean = idx => true): List[(Int, Int)]
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
-
def
toString(): String
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.
- returns
a String representation of the object.
- Definition Classes
- AnyRef → Any
-
def
variableName(str: String): String
Extracts variable name from a string, stripping any pair of surrounding braces
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
The Scala compiler API.
The following resources are useful for Scala plugin/compiler development: