Skip to content

remove author tags from Scaladoc #310

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 5, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,6 @@

package scala.util.parsing.input

/**
* @author Tomáš Janoušek
*/
private[input] trait PositionCache {
private lazy val indexCacheTL =
// not DynamicVariable as that would share the map from parent to child :-(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,6 @@ import scala.language.implicitConversions
* The `headOptionTailToFunList` converts a function that takes a `List[A]` to a function that
* accepts a `~[A, Option[List[A]]]` (this happens when parsing something of the following
* shape: `p ~ opt("." ~ repsep(p, "."))` -- where `p` is a parser that yields an `A`).
*
* @author Martin Odersky
* @author Iulian Dragos
* @author Adriaan Moors
*/
trait ImplicitConversions { self: Parsers =>
implicit def flatten2[A, B, C] (f: (A, B) => C): A ~ B => C =
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,6 @@ import scala.language.implicitConversions
* @see Alessandro Warth, James R. Douglass, Todd Millstein: "Packrat Parsers Can Support Left Recursion." PEPM'08
*
* @since 2.8
* @author Manohar Jonnalagedda
* @author Tiark Rompf
*/

trait PackratParsers extends Parsers {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,10 +72,6 @@ import scala.language.implicitConversions
* methods `success`, `err` and `failure` as examples.
*
* @see [[scala.util.parsing.combinator.RegexParsers]] and other known subclasses for practical examples.
*
* @author Martin Odersky
* @author Iulian Dragos
* @author Adriaan Moors
*/
trait Parsers {
/** the type of input elements the provided parsers consume (When consuming
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,6 @@ import input.CharArrayReader.EofCh
*
* Refer to [[scala.util.parsing.combinator.lexical.StdLexical]]
* for a concrete implementation for a simple, Scala-like language.
*
* @author Martin Odersky, Adriaan Moors
*/
abstract class Lexical extends Scanners with Tokens {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,6 @@ import input._
*
* See its subclasses [[scala.util.parsing.combinator.lexical.Lexical]] and -- most interestingly
* [[scala.util.parsing.combinator.lexical.StdLexical]], for more functionality.
*
* @author Martin Odersky, Adriaan Moors
*/
trait Scanners extends Parsers {
type Elem = Char
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,6 @@ import scala.collection.mutable
* Usually this component is used to break character-based input into
* bigger tokens, which are then passed to a token-parser (see
* [[scala.util.parsing.combinator.syntactical.TokenParsers]].)
*
* @author Martin Odersky
* @author Iulian Dragos
* @author Adriaan Moors
*/
class StdLexical extends Lexical with StdTokens {
// see `token` in `Scanners`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,6 @@ import lexical.StdLexical
import scala.language.implicitConversions

/** This component provides primitive parsers for the standard tokens defined in `StdTokens`.
*
* @author Martin Odersky, Adriaan Moors
*/
class StandardTokenParsers extends StdTokenParsers {
type Tokens = StdTokens
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,6 @@ import scala.collection.mutable
import scala.language.implicitConversions

/** This component provides primitive parsers for the standard tokens defined in `StdTokens`.
*
* @author Martin Odersky, Adriaan Moors
*/
trait StdTokenParsers extends TokenParsers {
type Tokens <: StdTokens
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,6 @@ package combinator
package syntactical

/** This is the core component for token-based parsers.
*
* @author Martin Odersky
* @author Adriaan Moors
*/
trait TokenParsers extends Parsers {
/** `Tokens` is the abstract type of the `Token`s consumed by the parsers in this component. */
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,6 @@ package combinator
package token

/** This component provides the standard `Token`s for a simple, Scala-like language.
*
* @author Martin Odersky
* @author Adriaan Moors
*/
trait StdTokens extends Tokens {
/** The class of keyword tokens */
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,6 @@ package token

/** This component provides the notion of `Token`, the unit of information that is passed from lexical
* parsers in the `Lexical` component to the parsers in the `TokenParsers` component.
*
* @author Martin Odersky
* @author Adriaan Moors
*/
trait Tokens {
/** Objects of this type are produced by a lexical parser or ``scanner``, and consumed by a parser.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,6 @@ package scala
package util.parsing.input

/** An object encapsulating basic character constants.
*
* @author Martin Odersky
* @author Adriaan Moors
*/
object CharArrayReader {
final val EofCh = '\u001a'
Expand All @@ -27,9 +24,6 @@ object CharArrayReader {
*
* @param chars an array of characters
* @param index starting offset into the array; the first element returned will be `source(index)`
*
* @author Martin Odersky
* @author Adriaan Moors
*/
class CharArrayReader(chars: Array[Char], index: Int = 0)
extends CharSequenceReader(java.nio.CharBuffer.wrap(chars), index)
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ package scala
package util.parsing.input

/** An object encapsulating basic character constants.
*
* @author Martin Odersky, Adriaan Moors
*/
object CharSequenceReader {
final val EofCh = '\u001a'
Expand All @@ -26,8 +24,6 @@ object CharSequenceReader {
*
* @param source the source sequence
* @param offset starting offset.
*
* @author Martin Odersky
*/
class CharSequenceReader(override val source: java.lang.CharSequence,
override val offset: Int) extends Reader[Char] {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,6 @@ package scala
package util.parsing.input

/** Undefined position.
*
* @author Martin Odersky
* @author Adriaan Moors
*/
object NoPosition extends Position {
def line = 0
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,6 @@ import scala.collection.mutable.ArrayBuffer
*
* @param source The source document
* @param offset The offset indicating the position
*
* @author Martin Odersky
*/
case class OffsetPosition(source: CharSequence, offset: Int) extends Position {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,6 @@ import PagedSeq._
*
* @tparam T the type of the elements contained in this paged sequence, with an `ClassTag` context bound.
*
* @author Martin Odersky
* @define Coll `PagedSeq`
* @define coll paged sequence
* @define mayNotTerminateInf
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,6 @@ package scala
package util.parsing.input

/** An object encapsulating basic character constants.
*
* @author Martin Odersky
* @author Adriaan Moors
*/
object PagedSeqReader {
final val EofCh = '\u001a'
Expand All @@ -27,8 +24,6 @@ object PagedSeqReader {
*
* @param seq the source sequence
* @param offset starting offset.
*
* @author Martin Odersky
*/
class PagedSeqReader(seq: PagedSeq[Char],
override val offset: Int) extends Reader[Char] { outer =>
Expand Down
3 changes: 0 additions & 3 deletions shared/src/main/scala/scala/util/parsing/input/Position.scala
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,6 @@ package util.parsing.input
* - comparing two positions (`<`).
*
* To use this class for a concrete kind of `document`, implement the `lineContents` method.
*
* @author Martin Odersky
* @author Adriaan Moors
*/
trait Position {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ package scala
package util.parsing.input

/** A trait for objects that have a source position.
*
* @author Martin Odersky, Adriaan Moors
*/
trait Positional {

Expand Down
3 changes: 0 additions & 3 deletions shared/src/main/scala/scala/util/parsing/input/Reader.scala
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,6 @@ package util.parsing.input


/** An interface for streams of values that have positions.
*
* @author Martin Odersky
* @author Adriaan Moors
*/
abstract class Reader[+T] {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ package scala
package util.parsing.input

/** An object to create a `StreamReader` from a `java.io.Reader`.
*
* @author Miles Sabin
*/
object StreamReader {
final val EofCh = '\u001a'
Expand All @@ -42,9 +40,6 @@ object StreamReader {
*
* If you need to match regexes spanning several lines you should consider
* class `PagedSeqReader` instead.
*
* @author Miles Sabin
* @author Martin Odersky
*/
sealed class StreamReader private (seq: PagedSeq[Char], off: Int, lnum: Int, nextEol0: Int) extends PagedSeqReader(seq, off) {
def this(seq: PagedSeq[Char], off: Int, lnum: Int) = this(seq, off, lnum, -1)
Expand Down