c

com.lightbend.paradox.markdown

ApiDocDirective

abstract class ApiDocDirective extends ExternalLinkDirective

API doc directive.

Link to javadoc and scaladoc based on package prefix. Will match the configured base URL with the longest package prefix. For example, given:

- scaladoc.akka.base_url=http://doc.akka.io/api/akka/x.y.z - scaladoc.akka.http.base_url=http://doc.akka.io/api/akka-http/x.y.z

Then @scaladoc[Http](akka.http.scaladsl.Http) will match the latter.

Linear Supertypes
ExternalLinkDirective, SourceDirective, InlineDirective, Directive, AnyRef, Any
Known Subclasses
JavadocDirective, ScaladocDirective
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ApiDocDirective
  2. ExternalLinkDirective
  3. SourceDirective
  4. InlineDirective
  5. Directive
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ApiDocDirective(name: String, page: Page, variables: Map[String, String])

Abstract Value Members

  1. abstract def page: Page
    Definition Classes
    SourceDirective
  2. abstract def resolveApiLink(base: Url, link: String): Url

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val ApiDocProperty: Regex
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. val baseUrls: Map[String, PropertyUrl]
  7. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. val defaultBaseUrl: PropertyUrl
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. val format: Set[Format]
    Definition Classes
    InlineDirective → Directive
  13. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. val names: String*
    Definition Classes
    InlineDirective → Directive
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  20. def render(node: DirectiveNode, visitor: Visitor, printer: Printer): Unit
    Definition Classes
    ExternalLinkDirective → Directive
  21. def resolveLink(node: DirectiveNode, link: String): Url
    Definition Classes
    ApiDocDirective → ExternalLinkDirective
  22. def resolvedSource(node: DirectiveNode, page: Page): String
    Attributes
    protected
    Definition Classes
    ExternalLinkDirective → SourceDirective
  23. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  24. def toString(): String
    Definition Classes
    AnyRef → Any
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from ExternalLinkDirective

Inherited from SourceDirective

Inherited from InlineDirective

Inherited from Directive

Inherited from AnyRef

Inherited from Any

Ungrouped