scaladoc
API
Generated with
Copyright (c) 2002-2023, LAMP/EPFL
Copyright (c) 2002-2023, 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

Classlikes

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

Attributes

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

Attributes

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

Attributes

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

This object was generated by sbt-buildinfo.

This object was generated by sbt-buildinfo.

Attributes

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

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

Attributes

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

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

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

Attributes

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

Attributes

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

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

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
Supertypes
class Object
trait Matchable
class Any
object Main

Attributes

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

Attributes

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

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

Attributes

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

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

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

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

Attributes

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

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object Scaladoc

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

Companion
object
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
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
case Github
case Twitter
case Gitter
case Discord
object SocialLinks

Attributes

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

Attributes

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

Attributes

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

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object SourceLinks

Attributes

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

Attributes

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

Attributes

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

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

Attributes

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

Attributes

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

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

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

Attributes

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

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

Attributes

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

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

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 echo(m: String)(using CompilerContext): Unit
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
def warn(m: String, e: Throwable)(using CompilerContext): Unit
extension (s: Signature)
Generated with
Copyright (c) 2002-2023, LAMP/EPFL
Copyright (c) 2002-2023, LAMP/EPFL