diff options
Diffstat (limited to 'src/library/scala/util/parsing/input/PagedSeqReader.scala')
-rw-r--r-- | src/library/scala/util/parsing/input/PagedSeqReader.scala | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/src/library/scala/util/parsing/input/PagedSeqReader.scala b/src/library/scala/util/parsing/input/PagedSeqReader.scala index 725287a9b8..8b69aa074b 100644 --- a/src/library/scala/util/parsing/input/PagedSeqReader.scala +++ b/src/library/scala/util/parsing/input/PagedSeqReader.scala @@ -11,9 +11,10 @@ package scala.util.parsing.input import scala.collection.immutable.PagedSeq -/** An object encapsulating basic character constants +/** An object encapsulating basic character constants. * - * @author Martin Odersky, Adriaan Moors + * @author Martin Odersky + * @author Adriaan Moors */ object PagedSeqReader { final val EofCh = '\032' @@ -33,8 +34,8 @@ class PagedSeqReader(seq: PagedSeq[Char], override lazy val source: java.lang.CharSequence = seq - /** Construct a <code>PagedSeqReader</code> with its first element at - * <code>source(0)</code> and position <code>(1,1)</code>. + /** Construct a `PagedSeqReader` with its first element at + * `source(0)` and position `(1,1)`. */ def this(seq: PagedSeq[Char]) = this(seq, 0) @@ -45,25 +46,24 @@ class PagedSeqReader(seq: PagedSeq[Char], /** Returns a PagedSeqReader consisting of all elements except the first * - * @return If <code>atEnd</code> is <code>true</code>, the result will be - * <code>this'; otherwise, it's a <code>PagedSeqReader</code> containing - * the rest of input. + * @return If `atEnd` is `true`, the result will be `this'; + * otherwise, it's a `PagedSeqReader` containing the rest of input. */ def rest: PagedSeqReader = if (seq.isDefinedAt(offset)) new PagedSeqReader(seq, offset + 1) else this - /** The position of the first element in the reader + /** The position of the first element in the reader. */ def pos: Position = new OffsetPosition(source, offset) /** true iff there are no more elements in this reader (except for trailing - * EofCh's) + * EofCh's). */ def atEnd = !seq.isDefinedAt(offset) /** Returns an abstract reader consisting of all elements except the first - * <code>n</code> elements. + * `n` elements. */ override def drop(n: Int): PagedSeqReader = new PagedSeqReader(seq, offset + n) |