Scala Compiler 2.13.16 - scala.tools.nsc.doc.ScaladocSyntaxAnalyzer
Keywords: Scala Compiler 2.13.16 scala.tools.nsc.doc.ScaladocSyntaxAnalyzer

Scala Compiler2.13.16 < Back


# Packages

-  package root

  The Scala compiler and reflection APIs.

  The Scala compiler and reflection APIs.

  Definition Classes
    root
-  package scala
  Definition Classes
    root
-  package tools
  Definition Classes
    scala
-  package nsc
  Definition Classes
    tools
-  package doc
  Definition Classes
    nsc
-  package base
  Definition Classes
    doc
-  package doclet
  Definition Classes
    doc
-  package html
  Definition Classes
    doc
-  package model
  Definition Classes
    doc
- DocFactory
- DocParser
- Index
- ScaladocAnalyzer
- ScaladocGlobal
- ScaladocGlobalTrait
- ScaladocSyntaxAnalyzer
- Settings
- Uncompilable
- Universe

c

scala.tools.nsc.doc

# ScaladocSyntaxAnalyzer

###

#### abstract class ScaladocSyntaxAnalyzer[G <: Global] extends SyntaxAnalyzer

Source
  ScaladocAnalyzer.scala

Linear Supertypes
SyntaxAnalyzer, JavaParsers, JavaScanners, Parsers, ParsersCommon, MarkupParsers, Scanners, ScannersCommon, SubComponent, AnyRef, Any
Type Hierarchy

Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. ScaladocSyntaxAnalyzer
2. SyntaxAnalyzer
3. JavaParsers
4. JavaScanners
5. Parsers
6. ParsersCommon
7. MarkupParsers
8. Scanners
9. ScannersCommon
10. SubComponent
11. AnyRef
12. Any

Implicitly

1. by any2stringadd
2. by StringFormat
3. by Ensuring
4. by ArrowAssoc

1. Hide All
2. Show All

Visibility

1. Public
2. Protected

### Instance Constructors

1.  new ScaladocSyntaxAnalyzer(global: G)

### Type Members

1.  abstract class StdPhase extends GlobalPhase

   A standard phase template

   A standard phase template

   Definition Classes
     SubComponent
2.  class MarkupParser extends MarkupParserCommon
   Definition Classes
     MarkupParsers
3.  case class OpInfo(lhs: Global.Tree, operator: Global.TermName, targs: List[Global.Tree], offset: Parsers.Offset) extends Product with Serializable
   Definition Classes
     Parsers
4.  class OutlineParser extends SourceFileParser
   Definition Classes
     Parsers
5.  abstract class Parser extends ParserCommon
   Definition Classes
     Parsers
6.  class SourceFileParser extends Parser
   Definition Classes
     Parsers
7.  class UnitParser extends SourceFileParser
   Definition Classes
     Parsers
8.  abstract class ParserCommon extends AnyRef

   This is now an abstract class, only to work around the optimizer: methods in traits are never inlined.

   This is now an abstract class, only to work around the optimizer: methods in traits are never inlined.

   Definition Classes
     ParsersCommon
9.  class MalformedInput extends Exception
   Definition Classes
     Scanners
10.  class ParensAnalyzer extends UnitScanner
    Definition Classes
      Scanners
11.  abstract class Scanner extends CharArrayReader with TokenData with ScannerData with ScannerCommon with DocScanner
    Definition Classes
      Scanners
12.  trait ScannerData extends TokenData with CharArrayReaderData

    An interface to most of mutable data in Scanner defined in TokenData and CharArrayReader (+ next, prev fields) with copyFrom functionality to backup/restore data (used by quasiquotes' lookingAhead).

    An interface to most of mutable data in Scanner defined in TokenData and CharArrayReader (+ next, prev fields) with copyFrom functionality to backup/restore data (used by quasiquotes' lookingAhead).

    Definition Classes
      Scanners
13.  class SourceFileScanner extends Scanner

    A scanner for a given source file not necessarily attached to a compilation unit.

    A scanner for a given source file not necessarily attached to a compilation unit. Useful for looking inside source files that are not currently compiled to see what's there

    Definition Classes
      Scanners
14.  trait TokenData extends CommonTokenData
    Definition Classes
      Scanners
15.  class UnitScanner extends SourceFileScanner

    A scanner over a given compilation unit

    A scanner over a given compilation unit

    Definition Classes
      Scanners
16.  trait CommonTokenData extends AnyRef
    Definition Classes
      ScannersCommon
17.  trait DocScanner extends AnyRef
    Definition Classes
      ScannersCommon
18.  trait ScannerCommon extends CommonTokenData
    Definition Classes
      ScannersCommon
19.  abstract class MemberDefTraverser extends Global.Traverser
    Definition Classes
      SyntaxAnalyzer
20.  class MemberPosReporter extends MemberDefTraverser
    Definition Classes
      SyntaxAnalyzer
21.  class ParserPhase extends StdPhase
    Definition Classes
      SyntaxAnalyzer
22.  type Location = Int
    Definition Classes
      Parsers
23.  type Offset = Int

    Offset into source character array

    Offset into source character array

    Definition Classes
      ScannersCommon
24.  type ParamOwner = Int
    Definition Classes
      Parsers
25.  class ScaladocJavaUnitParser extends JavaUnitParser
26.  class ScaladocJavaUnitScanner extends JavaUnitScanner with ScaladocScanner
27.  trait ScaladocScanner extends DocScanner
28.  class ScaladocUnitParser extends UnitParser
29.  class ScaladocUnitScanner extends UnitScanner with ScaladocScanner
30.  type Token = Int
    Definition Classes
      ScannersCommon
31.  case class JavaOpInfo(operand: Global.Tree, operator: Global.Name, pos: Int) extends Product with Serializable
    Definition Classes
      JavaParsers
32.  abstract class JavaParser extends ParserCommon
    Definition Classes
      JavaParsers
33.  class JavaUnitParser extends JavaParser
    Definition Classes
      JavaParsers
34.  abstract class AbstractJavaScanner extends AbstractJavaTokenData

    ...

    ...

    Definition Classes
      JavaScanners
35.  abstract class AbstractJavaTokenData extends AnyRef
    Definition Classes
      JavaScanners
36.  abstract class JavaScanner extends AbstractJavaScanner with JavaTokenData with Cloneable with ScannerCommon with DocScanner

    A scanner for Java.

    A scanner for Java.

    Definition Classes
      JavaScanners
37.  trait JavaTokenData extends AbstractJavaTokenData

    A class for representing a token's data.

    A class for representing a token's data.

    Definition Classes
      JavaScanners
38.  class JavaUnitScanner extends JavaScanner
    Definition Classes
      JavaScanners

### Abstract Value Members

1.  abstract val runsAfter: List[String]

   Names of phases that must run before this phase.

   Names of phases that must run before this phase.

   Definition Classes
     SubComponent
2.  abstract val runsRightAfter: Option[String]

   Name of the phase that this phase must follow immediately.

   Name of the phase that this phase must follow immediately.

   Definition Classes
     SubComponent

### Concrete Value Members

1.  case object ConfusedAboutBracesControl extends ControlThrowable with Product with Serializable
   Definition Classes
     MarkupParsers
2.  case object MissingEndTagControl extends ControlThrowable with Product with Serializable
   Definition Classes
     MarkupParsers
3.  case object TruncatedXMLControl extends ControlThrowable with Product with Serializable
   Definition Classes
     MarkupParsers
4.  object ParamOwner
   Definition Classes
     Parsers
5.  final def !=(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
6.  final def ##: Int
   Definition Classes
     AnyRef → Any
7.  def +(other: String): String
   Implicit
     This member is added by an implicit conversion from ScaladocSyntaxAnalyzer[G] toany2stringadd[ScaladocSyntaxAnalyzer[G]] performed by method any2stringadd in scala.Predef.
   Definition Classes
     any2stringadd
8.  def ->[B](y: B): (ScaladocSyntaxAnalyzer[G], B)
   Implicit
     This member is added by an implicit conversion from ScaladocSyntaxAnalyzer[G] toArrowAssoc[ScaladocSyntaxAnalyzer[G]] performed by method ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @inline()
9.  final def ==(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
10.  final val InBlock: Location
    Definition Classes
      Parsers
11.  final val InTemplate: Location
    Definition Classes
      Parsers
12.  final val Local: Location
    Definition Classes
      Parsers
13.  lazy val ScalaValueClassNames: collection.immutable.Seq[G.TypeName]
    Definition Classes
      Parsers
14.  final def afterOwnPhase[T](op: => T): T
    Definition Classes
      SubComponent
    Annotations
      @inline()
15.  final def asInstanceOf[T0]: T0
    Definition Classes
      Any
16.  final def beforeOwnPhase[T](op: => T): T
    Definition Classes
      SubComponent
    Annotations
      @inline()
17.  def clone(): AnyRef
    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.CloneNotSupportedException]) @native()
18.  def createKeywordArray(keywords: Seq[(G.Name, Token)], defaultToken: Token): (Token, Array[Token])
    Definition Classes
      ScannersCommon
19.  def enabled: Boolean

    Is this component enabled? Default is true.

    Is this component enabled? Default is true.

    Definition Classes
      SubComponent
20.  def ensuring(cond: (ScaladocSyntaxAnalyzer[G]) => Boolean, msg: => Any): ScaladocSyntaxAnalyzer[G]
    Implicit
      This member is added by an implicit conversion from ScaladocSyntaxAnalyzer[G] toEnsuring[ScaladocSyntaxAnalyzer[G]] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
21.  def ensuring(cond: (ScaladocSyntaxAnalyzer[G]) => Boolean): ScaladocSyntaxAnalyzer[G]
    Implicit
      This member is added by an implicit conversion from ScaladocSyntaxAnalyzer[G] toEnsuring[ScaladocSyntaxAnalyzer[G]] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
22.  def ensuring(cond: Boolean, msg: => Any): ScaladocSyntaxAnalyzer[G]
    Implicit
      This member is added by an implicit conversion from ScaladocSyntaxAnalyzer[G] toEnsuring[ScaladocSyntaxAnalyzer[G]] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
23.  def ensuring(cond: Boolean): ScaladocSyntaxAnalyzer[G]
    Implicit
      This member is added by an implicit conversion from ScaladocSyntaxAnalyzer[G] toEnsuring[ScaladocSyntaxAnalyzer[G]] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
24.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
25.  def equals(other: Any): Boolean
    Definition Classes
      SubComponent → AnyRef → Any
26.  def finalize(): Unit
    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.Throwable])
27.  final def getClass(): Class[_ <: AnyRef]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
28.  val global: G

    The global environment; overridden by instantiation in Global.

    The global environment; overridden by instantiation in Global.

    Definition Classes
      ScaladocSyntaxAnalyzer → JavaParsers → JavaScanners → Parsers → ParsersCommon → Scanners → ScannersCommon → SubComponent
29.  def hashCode(): Int

    SubComponents are added to a HashSet and two phases are the same if they have the same name.

    SubComponents are added to a HashSet and two phases are the same if they have the same name.

    Definition Classes
      SubComponent → AnyRef → Any
30.  val initial: Boolean

    True if this phase runs before all other phases.

    True if this phase runs before all other phases. Usually, `parser`.

    Definition Classes
      SubComponent
31.  val internal: Boolean

    True if this phase is not provided by a plug-in.

    True if this phase is not provided by a plug-in.

    Definition Classes
      SubComponent
32.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
33.  def literalUnit: G.Literal
    Definition Classes
      ParsersCommon
34.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
35.  def newLiteral(const: Any): G.Literal
    Definition Classes
      ParsersCommon
36.  def newPhase(prev: Phase): StdPhase

    The phase factory

    The phase factory

    Definition Classes
      SyntaxAnalyzer → SubComponent
37.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
38.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
39.  def ownPhase: Phase

    The phase corresponding to this subcomponent in the current compiler run.

    The phase corresponding to this subcomponent in the current compiler run.

    Definition Classes
      SubComponent
40.  val phaseName: String

    The name of the phase

    The name of the phase

    Definition Classes
      SyntaxAnalyzer → SubComponent
41.  def phaseNewFlags: Long

    New flags defined by the phase which are not valid before

    New flags defined by the phase which are not valid before

    Definition Classes
      SubComponent
42.  def phaseNextFlags: Long

    New flags defined by the phase which are not valid until immediately after it

    New flags defined by the phase which are not valid until immediately after it

    Definition Classes
      SubComponent
43.  val requires: List[String]

    Names of phases required by this component.

    Names of phases required by this component. Default is `Nil`.

    Definition Classes
      SubComponent
44.  val runsBefore: List[String]

    Names of phases that must run after this phase.

    Names of phases that must run after this phase. Default is `Nil`.

    Definition Classes
      SubComponent
45.  final val scala3Keywords: Set[G.TermName]
    Definition Classes
      Scanners
46.  final val softModifierNames: Set[G.TermName]
    Definition Classes
      Scanners
47.  final def synchronized[T0](arg0: => T0): T0
    Definition Classes
      AnyRef
48.  val terminal: Boolean

    True if this phase runs after all other phases.

    True if this phase runs after all other phases. Usually, `terminal`.

    Definition Classes
      SubComponent
49.  def toString(): String
    Definition Classes
      AnyRef → Any
50.  final val token2name: Map[Int, G.Name]
    Definition Classes
      Scanners
51.  def token2string(token: Token): String

    Returns the string representation of given token.

    Returns the string representation of given token.

    Definition Classes
      Scanners
52.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
53.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
54.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException]) @native()
55.  object JavaScannerConfiguration
    Definition Classes
      JavaScanners

### Deprecated Value Members

1.  def formatted(fmtstr: String): String
   Implicit
     This member is added by an implicit conversion from ScaladocSyntaxAnalyzer[G] toStringFormat[ScaladocSyntaxAnalyzer[G]] performed by method StringFormat in scala.Predef.
   Definition Classes
     StringFormat
   Annotations
     @deprecated @inline()
   Deprecated

     (Since version 2.12.16) Use `formatString.format(value)` instead of `value.formatted(formatString)`, or use the `f""` string interpolator. In Java 15 and later, `formatted` resolves to the new method in String which has reversed parameters.

2.  def →[B](y: B): (ScaladocSyntaxAnalyzer[G], B)
   Implicit
     This member is added by an implicit conversion from ScaladocSyntaxAnalyzer[G] toArrowAssoc[ScaladocSyntaxAnalyzer[G]] performed by method ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @deprecated
   Deprecated

     (Since version 2.13.0) Use `->` instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

### Inherited from SyntaxAnalyzer

### Inherited from JavaParsers

### Inherited from JavaScanners

### Inherited from Parsers

### Inherited from ParsersCommon

### Inherited from MarkupParsers

### Inherited from Scanners

### Inherited from ScannersCommon

### Inherited from SubComponent

### Inherited from AnyRef

### Inherited from Any

### Inherited by implicit conversion any2stringadd fromScaladocSyntaxAnalyzer[G] to any2stringadd[ScaladocSyntaxAnalyzer[G]]

### Inherited by implicit conversion StringFormat fromScaladocSyntaxAnalyzer[G] to StringFormat[ScaladocSyntaxAnalyzer[G]]

### Inherited by implicit conversion Ensuring fromScaladocSyntaxAnalyzer[G] to Ensuring[ScaladocSyntaxAnalyzer[G]]

### Inherited by implicit conversion ArrowAssoc fromScaladocSyntaxAnalyzer[G] to ArrowAssoc[ScaladocSyntaxAnalyzer[G]]

### Ungrouped