_layouts.api-page.html Maven / Gradle / Ivy
---
layout: main
---
{{ entity.kind | first | capitalize }}
{{ entity.modifiers | join: " " }}
{{ entity.kind }}
{{ entity.name }}
{% if entity.typeParams and entity.typeParams.size > 0 %}
[{{ entity.typeParams | join: ", " }}]
{% endif %}
{% if entity.superTypes.size > 0 %}
extends
{% if entity.superTypes.size == 1 %}
{% renderLink entity.superTypes[0] %}
{% else %}
{% renderLink entity.superTypes[0] %}
with {% renderLink entity.superTypes[1] %}
{% if entity.superTypes.size == 3 %}
with {% renderLink entity.superTypes[2] %}
{% elsif entity.superTypes.size > 3 %}
{% assign remaining = entity.superTypes.size | minus: 2 %}
and {{remaining}} more traits
{% endif %}
{% endif %}
{% endif %}
{% if entity.comment.body %}
{{ entity.comment.body }}
{% endif %}
{% if entity.superTypes.size > 0 %}
Supertypes
{% for superT in entity.superTypes %}
{% renderLink superT %}{% unless forloop.last %}, {% endunless %}
{% endfor %}
{% endif %}
{% if entity.annotations.size > 0 %}
Annotations
{% for annot in entity.annotations %}
@{{ annot }}{% unless forloop.last %}, {% endunless %}
{% endfor %}
{% endif %}
{% if entity.kind == "class" or entity.kind == "case class" %}
Constructors
{% if entity.constructors and entity.constructors.size > 0 %}
{% for ctorParamLists in entity.constructors %}
{{ entity.name }}
{% for plist in ctorParamLists %}
(
{% if plist.isImplicit %}
implicit
{% endif %}
{% for param in plist.list %}
{{ param.title }}:
{% if param.isByName %}=>{% endif %}
{% renderRef param.ref %}
{% unless forloop.last %}, {% endunless %}
{% endfor %}
)
{% endfor %}
{% endfor %}
{% else %}
This {{ entity.kind }} cannot be constructed.
{% endif %}
{% endif %}
Members
{% for member in entity.members %}
{% if member.isPrivate or member.isProtected %}
{% assign visibilityClass = "non-public" %}
{% else %}
{% assign visibilityClass = "public" %}
{% endif %}
{% if member.isImplicitlyAddedFrom != null %}
{% assign implicitClass = "implicitly" %}
{% else %}
{% assign implicitClass = "" %}
{% endif %}
{% assign kindClass = member.kind | replace: " ", "-" %}
{% assign sig = member.signature %}
{{ member.modifiers | join: " " }}
{{ member.kind }}
{% if member.kind == "class" or member.kind == "case class" or member.kind == "object" or member.kind == "trait" %}
{{ member.name }}
{% elsif member.kind == "package" %}
{{ member.name }}
{% else %}
{{ member.name }}
{% endif %}
{% if member.typeParams and member.typeParams.size > 0 %}
[{{ member.typeParams | join: ", " }}]
{% endif %}
{% if member.paramLists and member.paramLists.size > 0 %}
{% for plist in member.paramLists %}
(
{% if plist.isImplicit %}
implicit
{% endif %} {% for param in plist.list %}
{{ param.title }}:
{% if param.isByName %}=>{% endif %}
{% renderRef param.ref %}
{% unless forloop.last %}, {% endunless %}
{% endfor %}
)
{% endfor %}
{% endif %}
{% if member.returnValue %}
: {% renderRef member.returnValue %}
{% endif %}
{% if member.alias %}
= {% renderRef member.alias %}
{% endif %}
{% if member.comment.short %}
{{ member.comment.short }}
{% else %}
{% endif %}
{% assign c = member.comment %}
{% if c %}
{{ c.body }}
{% else %}
{% endif %}
{% endfor %}