scaladoc
API
Generated with
© 2002-2021 · LAMP/EPFL
© 2002-2021 · LAMP/EPFL
scaladoc/dotty.tools.scaladoc

dotty.tools.scaladoc

package dotty.tools.scaladoc

Members list

Concise view

Type members

Classlikes

case class Annotation(dri: DRI, params: List[AnnotationParameter])

Attributes

Companion:
object
Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any
object Annotation

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
trait ArgParser[T]

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object SCFlagsParser.type
case object BuildInfo

This object was generated by sbt-buildinfo.

This object was generated by sbt-buildinfo.

Attributes

Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait Product
trait Equals
class Object
trait Matchable
class Any
Self type
trait Classlike

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
case Class
case Trait
case Enum
final case class DRI(location: String, anchor: String, externalLink: Option[String], symbolUUID: String)

Attributes

Companion:
object
Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any
object DRI

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
DRI.type
case class DefinedRepoSummary(origin: String, org: String, repo: String) extends RepoSummary

Attributes

Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any
case class DocContext(args: Args, compilerContext: CompilerContext)

Attributes

Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any
enum DocLink

Attributes

Graph
Supertypes
trait Enum
trait Product
trait Equals
class Object
trait Matchable
class Any
enum DocumentationKind

Attributes

Graph
Supertypes
trait Enum
trait Product
trait Equals
class Object
trait Matchable
class Any
case class ExtensionTarget(name: String, typeParams: Seq[TypeParameter], argsLists: Seq[ParametersList], signature: Signature, dri: DRI, position: Long)

Attributes

Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any
case class ExternalDocLink(originRegexes: List[Regex], documentationUrl: URL, kind: DocumentationKind, packageListUrl: Option[URL])

Attributes

Companion:
object
Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any
object ExternalDocLink

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class HierarchyGraph(edges: Seq[(LinkToType, LinkToType)], sealedNodes: Set[LinkToType])

Attributes

Companion:
object
Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any
object HierarchyGraph

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class ImplicitConversion(from: DRI, to: DRI)

Attributes

Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any
trait ImplicitConversionProvider

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
case Given
case class InheritedFrom(name: String, dri: DRI, isSourceSuperclassHidden: Boolean)

Attributes

Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any
object Inkuire

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type
Inkuire.type
case class Keyword(name: String) extends SignaturePart

Attributes

Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any
enum Kind(val name: String)

Attributes

Graph
Supertypes
trait Enum
trait Product
trait Equals
class Object
trait Matchable
class Any
Known subtypes
case Class
case Trait
case Enum
case Def
case Type
case Given
case class Link(name: String, dri: DRI)

Attributes

Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any
case class LinkToType(signature: Signature, dri: DRI, kind: Kind)

Attributes

Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any
class Main

Main class for the doctool when used from cli.

Main class for the doctool when used from cli.

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
object Main

Attributes

Companion:
class
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
Main.type
case class Member(name: String, fullName: String, dri: DRI, kind: Kind, visibility: Visibility, modifiers: Seq[Modifier], annotations: List[Annotation], signature: Signature, sources: Option[TastyMemberSource], origin: Origin, inheritedFrom: Option[InheritedFrom], graph: HierarchyGraph, docs: Option[Comment], members: Seq[Member], directParents: Seq[LinkToType], parents: Seq[LinkToType], selfType: Option[LinkToType], knownChildren: Seq[LinkToType], companion: Option[(Kind, DRI)], deprecated: Option[Annotation])

Attributes

Companion:
object
Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any
object Member

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Member.type
case class MemberSignature(prefix: Signature, kind: Signature, name: Signature, suffix: Signature)

Attributes

Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any
enum Modifier(val name: String, val prefix: Boolean)

Attributes

Graph
Supertypes
trait Enum
trait Product
trait Equals
class Object
trait Matchable
class Any
case class Module(rootPackage: Member, members: Map[DRI, Member])

Attributes

Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any
case class Name(name: String, dri: DRI) extends SignaturePart

Attributes

Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any
case class NavigationNode(name: String, dri: DRI, nested: Seq[NavigationNode])

Attributes

Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any
enum Origin

Attributes

Graph
Supertypes
trait Enum
trait Product
trait Equals
class Object
trait Matchable
class Any
case class Overridden(name: String, dri: DRI)

Attributes

Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any
case class PageContent(content: AppliedTag, toc: Seq[TocEntry])

Attributes

Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any
case class Parameter(annotations: Seq[Annotation], modifiers: String, name: Option[String], dri: DRI, signature: Signature, isExtendedSymbol: Boolean, isGrouped: Boolean)

Attributes

Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any
case class ParametersList(parameters: Seq[Parameter], modifiers: String)

Attributes

Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any
case class PathBased[T](entries: List[Entry[T]], projectRoot: Path)

Attributes

Companion:
object
Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any
object PathBased

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class Plain(name: String) extends SignaturePart

Attributes

Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any
case class QuickLink(text: String, url: String)

Attributes

Companion:
object
Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any
object QuickLink

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed class RepoSummary

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object UnknownRepoSummary.type
object ScalaModuleProvider

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type
object Scaladoc

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type
object ScaladocCommand extends CliCommand

Attributes

Graph
Supertypes
trait CliCommand
class Object
trait Matchable
class Any
Self type
class ScaladocSettings extends SettingGroup with AllScalaSettings

Attributes

Graph
Supertypes
trait AllScalaSettings
trait CommonScalaSettings
class SettingGroup
class Object
trait Matchable
class Any
object Signature

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type
sealed trait SignaturePart

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Keyword
class Name
class Plain
class Type
object SnippetCompilerData

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class SnippetCompilerData(packageName: String, position: Position)

Attributes

Companion:
object
Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any
enum SocialLinks(val url: String, val className: String)

Attributes

Companion:
object
Graph
Supertypes
trait Enum
trait Product
trait Equals
class Object
trait Matchable
class Any
Known subtypes
case Github
case Twitter
case Gitter
case Discord
object SocialLinks

Attributes

Companion:
enum
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
trait SourceLink

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class SourceLinkParser(revision: Option[String]) extends ArgParser[SourceLink]

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
class SourceLinks(sourceLinks: PathBased[SourceLink])

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
object SourceLinks

Attributes

Companion:
class
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
case class TastyMemberSource(path: Path, lineNumber: Int)

Attributes

Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any
case class TemplateSourceLink(urlTemplate: String) extends SourceLink

Attributes

Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any
case class TocEntry(level: Int, content: String, anchor: String)

Attributes

Companion:
object
Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any
object TocEntry

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class Type(name: String, dri: Option[DRI]) extends SignaturePart

Attributes

Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any
case class TypeParameter(annotations: Seq[Annotation], variance: "" | "+" | "-", name: String, dri: DRI, signature: Signature)

Attributes

Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any
case object UnknownRepoSummary extends RepoSummary

Attributes

Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait Product
trait Equals
class Object
trait Matchable
class Any
Self type
enum Visibility(val name: String)

Attributes

Graph
Supertypes
trait Enum
trait Product
trait Equals
class Object
trait Matchable
class Any
Known subtypes
case Private
enum VisibilityScope

Attributes

Graph
Supertypes
trait Enum
trait Product
trait Equals
class Object
trait Matchable
class Any
case class WebBasedSourceLink(repoSummary: RepoSummary, prefix: String, revision: String, subPath: String) extends SourceLink

Attributes

Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any

Types

type CompilerContext = Context
type DocPart = Seq[WikiDocElement] | Node
type JHashMap[K, V] = HashMap[K, V]
type JList[T] = List[T]
type JMap[K, V] = Map[K, V]
type JMapEntry[K, V] = Entry[K, V]
type JSet[T] = Set[T]
type Operation = "view" | "edit"

Value members

Concrete methods

def JList[T](e: T*): List[T]
def JMap[K, V](e: (K, V)*): Map[K, V]
def JNil[A]: List[A]
def JSet[T](e: T*): Set[T]
def emptyJMap[A, B]: Map[A, B]
def relativePath(p: Path)(using Context): Path

Concrete fields

val report: report.type

Givens

Givens

given compilerContext(using docContext: DocContext): CompilerContext

Extensions

Extensions

extension [V](jlist: List[V])
def ++(other: List[V]): List[V]
extension [V](jset: Set[V])
def ++(other: Set[V]): Set[V]
extension (m: Module)
def visitMembers(callback: Member => Unit): Unit
extension (members: Seq[Member])
extension (r: report.type)
def error(m: String, f: File, e: Throwable | Null)(using CompilerContext): Unit
def warn(m: String, f: File, e: Throwable)(using CompilerContext): Unit
def warn(m: String, f: File)(using CompilerContext): Unit
extension (s: Signature)
Generated with
© 2002-2021 · LAMP/EPFL
© 2002-2021 · LAMP/EPFL