<% extends skins/base.html %> <% subskin head %> <% subskin menu %>
<% repositoryName %>
<% subskin moduleItem %>
  • <% module.id %>
  • <% subskin content %>

    Module <% moduleId %>

    <% item.fileoverview | markdown %>
    <% if <% item.example %> render exampleSection %> <% if <% item.sees.length %> render seesSection %>
    <% if <% item.danglingFunctions.length %> or <% item.danglingProperties.length %> render danglingOverview %>
    <% for class in <% item.classes %> render classOverview %>

    <% for item in <% item.items %> render docItem %>
    <% subskin danglingOverview %>
    <% if <% item.danglingFunctions.length %> render moduleFunctionsOverview %> <% if <% item.danglingProperties.length %> render modulePropertiesOverview %>
    <% subskin moduleFunctionsOverview %>

    Functions

    <% subskin modulePropertiesOverview %>

    Properties

    <% subskin propertyOverview %>
  • <% item.shortName %><% if <% item.isFunction %> render parameterLine %>
  • <% subskin parameterLine %> (<% item.parameters | listProperty 'name' %>) <% subskin classOverview %>

    Class <% class.name %>

    <% if <% class.methods.length %> render classMethodsOverview %> <% if <% class.properties.length %> render classPropertiesOverview %> <% if <% class.staticMethods.length %> render classStaticMethodsOverview %> <% if <% class.staticProperties.length %> render classStaticPropertiesOverview %>
    <% subskin classMethodsOverview %>

    Instance Methods

    <% subskin classPropertiesOverview %>

    Instance Properties

    <% subskin classStaticMethodsOverview %>

    Static Methods

    <% subskin classStaticPropertiesOverview %>

    Static Properties

    <% subskin docItem %>

    <% render namePrefix %><% item.shortName %> <% if <% item.isFunction %> render parameterLine %>

    <% item.desc | markdown %>
    <% if <% item.example %> render exampleSection %> <% if <% item.parameters.length %> and <% item.parameters | haveDescOrType %> render parametersSection %> <% if <% item.returns.name %> or <% item.returns.type %> render returnsSection %> <% if <% item.throws.length %> render throwsSection %> <% if <% item.sees.length %> render seesSection %>

    <% subskin namePrefix %> <% item.relatedClass %><% if <% item.relatedClass %> echo '.' %><% if <%item.relatedClass %> and not <% item.isStatic %> echo 'prototype.' %><% subskin parametersSection %>

    Parameters

    <% for param in <% item.parameters %> render parameterRow %>
    <% subskin seesSection %>

    See

    <% item.sees | join '
    '%>
    <% subskin throwsSection %>

    Throws

    <% item.throws | join ',' %>
    <% subskin returnsSection %>

    <% if <% item.isFunction %> echo 'Returns' %> <% if not <% item.isProperty %> echo 'Type' %>

    <% item.returns.type %> <% item.returns.name %>
    <% subskin parameterRow %> <% param.type %> <% param.name %> <% param.desc %> <% subskin exampleSection %>

    Example

    <% item.example %>