scaladoc/dotty.tools.scaladoc

dotty.tools.scaladoc

package dotty.tools.scaladoc

Type members

Classlikes

case class Annotation(dri: DRI, params: List[AnnotationParameter])
Companion:
object
object Annotation
Companion:
class
trait ArgParser[T]
case object BuildInfo

This object was generated by sbt-buildinfo.

This object was generated by sbt-buildinfo.

trait Classlike
final case class DRI(location: String, anchor: String, externalLink: Option[String], symbolUUID: String)
Companion:
object
object DRI
Companion:
class
case class DefinedRepoSummary(origin: String, org: String, repo: String) extends RepoSummary
case class DocContext(args: Args, compilerContext: CompilerContext)
enum DocLink
enum DocumentationKind
case class ExtensionTarget(name: String, typeParams: Seq[TypeParameter], argsLists: Seq[ParametersList], signature: Signature, dri: DRI, position: Long)
case class ExternalDocLink(originRegexes: List[Regex], documentationUrl: URL, kind: DocumentationKind, packageListUrl: Option[URL])
Companion:
object
object ExternalDocLink
Companion:
class
case class HierarchyGraph(edges: Seq[(LinkToType, LinkToType)], sealedNodes: Set[LinkToType])
Companion:
object
object HierarchyGraph
Companion:
class
case class ImplicitConversion(from: DRI, to: DRI)
trait ImplicitConversionProvider
case class InheritedFrom(name: String, dri: DRI, isSourceSuperclassHidden: Boolean)
object Inkuire
case class Keyword(name: String) extends SignaturePart
enum Kind(val name: String)
case class Link(name: String, dri: DRI)
case class LinkToType(signature: Signature, dri: DRI, kind: Kind)
class Main

Main class for the doctool when used from cli.

Main class for the doctool when used from cli.

Companion:
object
object Main
Companion:
class
case class Member(name: 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[DRI], deprecated: Option[Annotation])
Companion:
object
object Member
Companion:
class
enum Modifier(val name: String, val prefix: Boolean)
case class Module(rootPackage: Member, members: Map[DRI, Member])
case class NavigationNode(name: String, dri: DRI, nested: Seq[NavigationNode])
enum Origin
case class Overridden(name: String, dri: DRI)
case class PageContent(content: AppliedTag, toc: Seq[TocEntry])
case class Parameter(annotations: Seq[Annotation], modifiers: String, name: Option[String], dri: DRI, signature: Signature, isExtendedSymbol: Boolean, isGrouped: Boolean)
case class ParametersList(parameters: Seq[Parameter], modifiers: String)
case class PathBased[T](entries: List[Entry[T]], projectRoot: Path)
Companion:
object
object PathBased
Companion:
class
case class Plain(name: String) extends SignaturePart
sealed class RepoSummary
object ScalaModuleProvider
object Scaladoc
object ScaladocCommand extends CliCommand
class ScaladocSettings extends SettingGroup with AllScalaSettings
object Signature
sealed trait SignaturePart
object SnippetCompilerData
Companion:
class
case class SnippetCompilerData(packageName: String, position: Position)
Companion:
object
enum SocialLinks(val url: String, val whiteIconName: String, val blackIconName: String)
Companion:
object
object SocialLinks
Companion:
class
trait SourceLink
class SourceLinkParser(revision: Option[String]) extends ArgParser[SourceLink]
class SourceLinks(sourceLinks: PathBased[SourceLink])
Companion:
object
object SourceLinks
Companion:
class
case class TastyMemberSource(path: Path, lineNumber: Int)
case class TemplateSourceLink(urlTemplate: String) extends SourceLink
case class TocEntry(level: Int, content: String, anchor: String)
Companion:
object
object TocEntry
Companion:
class
case class Type(name: String, dri: Option[DRI]) extends SignaturePart
case class TypeParameter(annotations: Seq[Annotation], variance: "" | "+" | "-", name: String, dri: DRI, signature: Signature)
case object UnknownRepoSummary extends RepoSummary
enum Visibility(val name: String)
enum VisibilityScope
case class WebBasedSourceLink(repoSummary: RepoSummary, prefix: String, revision: String, subPath: String) extends SourceLink

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)