scaladoc
DocsAPI
Generated with
Copyright (c) 2002-2025, LAMP/EPFL
Copyright (c) 2002-2025, LAMP/EPFL
scaladoc/dotty.tools/dotty.tools.scaladoc

dotty.tools.scaladoc

package dotty.tools.scaladoc

Members list

Packages

package dotty.tools.scaladoc.parsers
package dotty.tools.scaladoc.renderers
package dotty.tools.scaladoc.site
package dotty.tools.scaladoc.snippets
package dotty.tools.scaladoc.tasty
package dotty.tools.scaladoc.transformers
package dotty.tools.scaladoc.translators
package dotty.tools.scaladoc.util

Type members

Experimental classlikes

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

Attributes

Companion
object
Experimental
true
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Annotation

Attributes

Companion
class
Experimental
true
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Annotation.type
trait ArgParser[T]

Attributes

Experimental
true
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object SCFlagsParser
case object BuildInfo

This object was generated by sbt-buildinfo.

This object was generated by sbt-buildinfo.

Attributes

Experimental
true
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
BuildInfo.type
trait Classlike

Attributes

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

Attributes

Companion
object
Experimental
true
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object DRI

Attributes

Companion
class
Experimental
true
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

Experimental
true
Supertypes
trait Serializable
trait Product
trait Equals
class RepoSummary
class Object
trait Matchable
class Any
Show all
case class DocContext(args: Args, compilerContext: CompilerContext)

Attributes

Experimental
true
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
enum DocLink

Attributes

Experimental
true
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
enum DocumentationKind

Attributes

Experimental
true
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class ExtensionTarget(name: String, typeParams: Seq[TypeParameter], argsLists: Seq[TermParameterList], signature: Signature, dri: DRI, position: Long)

Attributes

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

Attributes

Companion
object
Experimental
true
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ExternalDocLink

Attributes

Companion
class
Experimental
true
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
Experimental
true
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object HierarchyGraph

Attributes

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

Attributes

Experimental
true
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
trait ImplicitConversionProvider

Attributes

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

Attributes

Experimental
true
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Inkuire

Attributes

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

Attributes

Experimental
true
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
enum Kind(val name: String)

Attributes

Experimental
true
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
class Class
class Trait
class Enum
class EnumCase
class Def
class Extension
class Constructor
class Exported
class Type
class Given
class Implicit
Show all
case class Link(name: String, dri: DRI)

Attributes

Experimental
true
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class LinkToType(signature: Signature, dri: DRI, kind: Kind)

Attributes

Experimental
true
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
class Main

Main class for the doctool when used from cli.

Main class for the doctool when used from cli.

Attributes

Companion
object
Experimental
true
Supertypes
class Object
trait Matchable
class Any
object Main

Attributes

Companion
class
Experimental
true
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], experimental: Option[Annotation])

Attributes

Companion
object
Experimental
true
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Member

Attributes

Companion
class
Experimental
true
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

Experimental
true
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
enum Modifier(val name: String, val prefix: Boolean)

Attributes

Experimental
true
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Module(rootPackage: Member, members: Map[DRI, Member])

Attributes

Experimental
true
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Name(name: String, dri: DRI) extends SignaturePart

Attributes

Experimental
true
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class NavigationNode(name: String, dri: DRI, nested: Seq[NavigationNode])

Attributes

Experimental
true
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
enum Origin

Attributes

Experimental
true
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Overridden(name: String, dri: DRI)

Attributes

Experimental
true
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class PageContent(content: AppliedTag, toc: Seq[TocEntry])

Attributes

Experimental
true
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class PathBased[T](entries: List[Entry[T]], projectRoot: Path)

Attributes

Companion
object
Experimental
true
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object PathBased

Attributes

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

Attributes

Experimental
true
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class QuickLink(text: String, url: String)

Attributes

Companion
object
Experimental
true
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object QuickLink

Attributes

Companion
class
Experimental
true
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
QuickLink.type
sealed class RepoSummary

Attributes

Experimental
true
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object ScalaModuleProvider

Attributes

Experimental
true
Supertypes
class Object
trait Matchable
class Any
Self type
object Scaladoc

Attributes

Experimental
true
Supertypes
class Object
trait Matchable
class Any
Self type
Scaladoc.type
object ScaladocCommand extends CliCommand

Attributes

Experimental
true
Supertypes
trait CliCommand
class Object
trait Matchable
class Any
Self type
class ScaladocSettings extends SettingGroup, AllScalaSettings

Attributes

Experimental
true
Supertypes
trait AllScalaSettings
trait CommonScalaSettings
class SettingGroup
class Object
trait Matchable
class Any
Show all
object Signature

Attributes

Experimental
true
Supertypes
class Object
trait Matchable
class Any
Self type
Signature.type
sealed trait SignaturePart

Attributes

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

Attributes

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

Attributes

Companion
object
Experimental
true
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
enum SocialLinks(val url: String, val className: String)

Attributes

Companion
object
Experimental
true
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
class Github
class Twitter
class Gitter
class Discord
class Custom
object SocialLinks

Attributes

Companion
enum
Experimental
true
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
trait SourceLink

Attributes

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

Attributes

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

Attributes

Companion
object
Experimental
true
Supertypes
class Object
trait Matchable
class Any
object SourceLinks

Attributes

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

Attributes

Experimental
true
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class TemplateSourceLink(urlTemplate: String) extends SourceLink

Attributes

Experimental
true
Supertypes
trait Serializable
trait Product
trait Equals
trait SourceLink
class Object
trait Matchable
class Any
Show all
case class TermParameter(annotations: Seq[Annotation], modifiers: String, name: Option[String], dri: DRI, signature: Signature, isExtendedSymbol: Boolean, isGrouped: Boolean)

Attributes

Experimental
true
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class TermParameterList(parameters: Seq[TermParameter], modifiers: String)

Attributes

Experimental
true
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class TocEntry(level: Int, content: String, anchor: String)

Attributes

Companion
object
Experimental
true
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object TocEntry

Attributes

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

Attributes

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

Attributes

Experimental
true
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case object UnknownRepoSummary extends RepoSummary

Attributes

Experimental
true
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class RepoSummary
class Object
trait Matchable
class Any
Show all
Self type
enum Visibility(val name: String)

Attributes

Experimental
true
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
class Protected
class Private
enum VisibilityScope

Attributes

Experimental
true
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class WebBasedSourceLink(repoSummary: RepoSummary, prefix: String, revision: String, subPath: String) extends SourceLink

Attributes

Experimental
true
Supertypes
trait Serializable
trait Product
trait Equals
trait SourceLink
class Object
trait Matchable
class Any
Show all

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

Experimental methods

def JList[T](e: T*): List[T]

Attributes

Experimental
true
def JMap[K, V](e: (K, V)*): Map[K, V]

Attributes

Experimental
true
def JNil[A]: List[A]

Attributes

Experimental
true
def JSet[T](e: T*): Set[T]

Attributes

Experimental
true
def emptyJMap[A, B]: Map[A, B]

Attributes

Experimental
true
def pathToString(p: Path): String

Attributes

Experimental
true
def relativePath(p: Path)(using Context): Path

Attributes

Experimental
true
def throwableToString(t: Throwable)(using CompilerContext): String

Attributes

Experimental
true

Experimental fields

val report: report.type

Attributes

Experimental
true
val staticFileSymbolUUID: String

Attributes

Experimental
true
val topLevelDri: DRI

Attributes

Experimental
true

Givens

Experimental givens

given compilerContext(using docContext: DocContext): CompilerContext

Attributes

Experimental
true

Extensions

Experimental extensions

extension [V](jlist: List[V])
def ++(other: List[V]): List[V]

Attributes

Experimental
true
extension [V](jset: Set[V])
def ++(other: Set[V]): Set[V]

Attributes

Experimental
true
extension (m: Module)
def updateMembers(op: Member => Member): Module

Attributes

Experimental
true
def updatePackages(op: Seq[Member] => Seq[Member]): Module

Attributes

Experimental
true
def visitMembers(callback: Member => Unit): Unit

Attributes

Experimental
true
extension [T](member: Member)
def getDirectParentsAsStrings: Seq[String]

Attributes

Experimental
true
def getKnownChildrenAsStrings: Seq[String]

Attributes

Experimental
true
def getParentsAsStrings: Seq[String]

Attributes

Experimental
true
def membersBy(op: Member => Boolean): Seq[Member]

Attributes

Experimental
true
def updateRecusivly(op: Member => Member): Member

Attributes

Experimental
true
def withDRI(dri: DRI): Member

Attributes

Experimental
true
def withDocs(docs: Option[Comment]): Member

Attributes

Experimental
true
def withKind(kind: Kind): Member

Attributes

Experimental
true
def withKnownChildren(knownChildren: Seq[LinkToType]): Member

Attributes

Experimental
true
def withMembers(newMembers: Seq[Member]): Member

Attributes

Experimental
true
def withName(name: String): Member

Attributes

Experimental
true
def withNewGraphEdges(edges: Seq[(LinkToType, LinkToType)]): Member

Attributes

Experimental
true
def withNewMembers(newMembers: Seq[Member]): Member

Attributes

Experimental
true
def withOrigin(origin: Origin): Member

Attributes

Experimental
true
extension (members: Seq[Member])
def byInheritance: (Seq[Member], Seq[Member])

Attributes

Experimental
true
extension (r: report.type)
def echo(m: String)(using CompilerContext): Unit

Attributes

Experimental
true
def error(m: String, f: File, e: Throwable | Null)(using CompilerContext): Unit

Attributes

Experimental
true
def warn(m: String, f: File, e: Throwable)(using CompilerContext): Unit

Attributes

Experimental
true
def warn(m: String, f: File)(using CompilerContext): Unit

Attributes

Experimental
true
def warn(m: String, e: Throwable)(using CompilerContext): Unit

Attributes

Experimental
true
extension (s: Signature)
def getName: String

Attributes

Experimental
true
Generated with
Copyright (c) 2002-2025, LAMP/EPFL
Copyright (c) 2002-2025, LAMP/EPFL