class Documentable::DocPage::Primary::Type

Renders a Documentable::Primary object

Defined as

class Documentable::DocPage::Primary::Type is Documentable::DocPage

Generates the pod of a Documentable::Primary instance with kind set to Kind::Type

method typegraph-fragment

Defined as

method typegraph-fragment($podname is copy)

Returns the HTML fragment necessary to display the TypeGraph image associated to this type.

method roles-done-by-type

Defined as

method roles-done-by-type($registry$doc)

Returns a pod list containing all routines supplied by the roles implemented by the type.

method parent-class

Defined as

method parent-class($registry$doc)

Returns a pod list containing all methods supplied by the parent classes of the type.

method roles-done-by-parent-class

Defined as

method roles-done-by-parent-class($registry$doc)

Returns a pod list containing all routines supplied by the roles implemented by the parent classes of the type.

method compose-type

Defined as

method compose-type($registry$doc)

Returns the $.pod attribute of $doc completed. That means, with the TypeGraph fragment and all its methods coming from another types.

Type Graph

Type relations for Documentable::DocPage::Primary::Type
perl6-type-graph Documentable::DocPage::Primary::Type Documentable::DocPage::Primary::Type Documentable::DocPage Documentable::DocPage Documentable::DocPage::Primary::Type->Documentable::DocPage

Expand above chart

Routines supplied by class Documentable::DocPage

Documentable::DocPage::Primary::Type inherits from class Documentable::DocPage, which provides the following routines:

(Documentable::DocPage) method render

Defined as

method render(| --> Hash{ ... }

It's an abstract method. It needs to return a Hash object following this format:

%(
    document => pod to be rendered as HTML,
    url      => URL assigned to this document
)

Returning the pod is necessary because we need to wrap it in a common HTML template (see Documentable::To::HTML::Wrapper).