summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorSeth Tisue <seth@tisue.net>2015-06-30 16:18:46 -0400
committerSeth Tisue <seth@tisue.net>2015-06-30 16:18:46 -0400
commit6ca8847eb5891fa610136c2c041cbad1298fb89c (patch)
tree8b0ecaaf6310174ac075312f883f5f9873a8234f /src
parent12f92b7f0566a9557dbb8d73bba21b72764eed68 (diff)
parentb1c7d210fce6d96d2edb8d57c4899cdf78ac2c70 (diff)
downloadscala-6ca8847eb5891fa610136c2c041cbad1298fb89c.tar.gz
scala-6ca8847eb5891fa610136c2c041cbad1298fb89c.tar.bz2
scala-6ca8847eb5891fa610136c2c041cbad1298fb89c.zip
Merge pull request #4591 from vsalvis/vsalvis-stringdoc
SI-8140 Documentation references java.lang.String directly
Diffstat (limited to 'src')
-rw-r--r--src/library/scala/Predef.scala5
-rw-r--r--src/library/scala/collection/immutable/StringOps.scala7
2 files changed, 8 insertions, 4 deletions
diff --git a/src/library/scala/Predef.scala b/src/library/scala/Predef.scala
index 0f300412b7..cef62922ac 100644
--- a/src/library/scala/Predef.scala
+++ b/src/library/scala/Predef.scala
@@ -82,6 +82,11 @@ object Predef extends LowPriorityImplicits with DeprecatedPredef {
*/
def classOf[T]: Class[T] = null // This is a stub method. The actual implementation is filled in by the compiler.
+ /** The `String` type in Scala has methods that come either from the underlying
+ * Java String (see the documentation corresponding to your Java version, for
+ * example [[http://docs.oracle.com/javase/8/docs/api/java/lang/String.html]]) or
+ * are added implicitly through [[scala.collection.immutable.StringOps]].
+ */
type String = java.lang.String
type Class[T] = java.lang.Class[T]
diff --git a/src/library/scala/collection/immutable/StringOps.scala b/src/library/scala/collection/immutable/StringOps.scala
index 6737692fb1..77333badf9 100644
--- a/src/library/scala/collection/immutable/StringOps.scala
+++ b/src/library/scala/collection/immutable/StringOps.scala
@@ -12,10 +12,9 @@ package immutable
import mutable.StringBuilder
-/**
- * This class serves as a wrapper providing `String`s with all the operations
- * found in indexed sequences. Where needed, instances of `String` object
- * are implicitly converted into this class.
+/** This class serves as a wrapper providing [[scala.Predef.String]]s with all
+ * the operations found in indexed sequences. Where needed, `String`s are
+ * implicitly converted into instances of this class.
*
* The difference between this class and `WrappedString` is that calling transformer
* methods such as `filter` and `map` will yield a `String` object, whereas a