class Documentable::DocPage::Index::Routine
Renders the index associated to Kind::Routine
Defined as
is Documentable::DocPage
Each and every value of Kind has an associated index. This index contains references and a brief description of all Documentable::Primary instances found in a Documentable::Registry with $.kind
set to Kind::Routine
.
Type Graph
Routines supplied by class Documentable::DocPage
Documentable::DocPage::Index::Routine 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).