lib/templates/class.html

{{>head}}

<div class="row row-offcanvas row-offcanvas-left">

  <div class="col-xs-6 col-sm-3 sidebar-offcanvas">
    <ol id="sidebar">
      {{#class.hasConstants}}
      <li class="section-title"><a href="#constants">Constants</a></li>
      {{#class.constants}}
      <li><a href="{{href}}">{{name}}</a></li>
      {{/class.constants}}
      {{/class.hasConstants}}

      {{#class.hasStaticProperties}}
      <li class="section-title"><a href="#static-properties">Static properties</a></li>
      {{#class.staticProperties}}
      <li><a href="{{href}}">{{name}}</a></li>
      {{/class.staticProperties}}
      {{/class.hasStaticProperties}}

      {{#class.hasStaticMethods}}
      <li class="section-title"><a href="#static-methods">Static methods</a></li>
      {{#class.staticMethods}}
      <li><a href="{{href}}">{{name}}</a></li>
      {{/class.staticMethods}}
      {{/class.hasStaticMethods}}

      {{#class.hasInstanceProperties}}
      <li class="section-title"><a href="#instance-properties">Properties</a></li>
      {{#class.instanceProperties}}
      <li><a href="{{href}}">{{name}}</a></li>
      {{/class.instanceProperties}}
      {{#class.inheritedProperties}}
      <li><a href="{{href}}">{{name}}</a></li>
      {{/class.inheritedProperties}}
      {{/class.hasInstanceProperties}}

      {{#class.hasConstructors}}
      <li class="section-title"><a href="#constructors">Constructors</a></li>
      {{#class.constructors}}
      <li><a href="{{href}}">{{shortName}}</a></li>
      {{/class.constructors}}
      {{/class.hasConstructors}}

      {{#class.hasOperators}}
      <li class="section-title"><a href="#operators">Operators</a></li>
      {{#class.operators}}
      <li><a href="{{href}}">{{name}}</a></li>
      {{/class.operators}}
      {{#class.inheritedOperators}}
      <li><a href="{{href}}">{{name}}</a></li>
      {{/class.inheritedOperators}}
      {{/class.hasOperators}}

      {{#class.hasMethods}}
      <li class="section-title"><a href="#methods">Methods</a></li>
      {{#class.instanceMethods}}
      <li><a href="{{href}}">{{name}}</a></li>
      {{/class.instanceMethods}}
      {{#class.inheritedMethods}}
      <li><a href="{{href}}">{{name}}</a></li>
      {{/class.inheritedMethods}}
      {{/class.hasMethods}}
    </ol>
  </div><!--/.sidebar-offcanvas-->

  <div class="col-xs-12 col-sm-9 main-content">

    {{#class}}
    {{>documentation}}
    {{/class}}

    {{#class.hasModifiers}}
    <section>
        <dl class="dl-horizontal">
        {{#class.hasAnnotations}}
        <dt>Annotations</dt>
        <dd><ul class="annotation-list class-relationships">
            {{#class.annotations}}
            <li>{{{.}}}</li>
            {{/class.annotations}}
        </ul></dd>
        {{/class.hasAnnotations}}

        {{#class.hasSupertype}}
        <dt>Extends</dt>
        <dd><ul class="gt-separated dark class-relationships">
            <li>{{{linkedObjectType}}}</li>
            {{#class.superChainReversed}}
            <li>{{{linkedName}}}</li>
            {{/class.superChainReversed}}
            <li>{{{name}}}</li>
        </ul></dd>
        {{/class.hasSupertype}}

        {{#class.hasInterfaces}}
        <dt>Implements</dt>
            <dd>
                <ul class="comma-separated class-relationships">
                    {{#class.interfaces}}
                    <li>{{{linkedName}}}</li>
                    {{/class.interfaces}}
                </ul>
            </dd>
        {{/class.hasInterfaces}}

        {{#class.hasMixins}}
        <dt>Mixes-in</dt>
        <dd><ul class="comma-separated class-relationships">
            {{#class.mixins}}
            <li>{{{linkedName}}}</li>
            {{/class.mixins}}
        </ul></dd>
        {{/class.hasMixins}}

        {{#class.hasImplementors}}
        <dt>Implemented by</dt>
        <dd><ul class="comma-separated class-relationships">
            {{#class.implementors}}
            <li>{{{linkedName}}}</li>
            {{/class.implementors}}
        </ul></dd>
        {{/class.hasImplementors}}
        </dl>
    </section>
    {{/class.hasModifiers}}

    {{#class.hasConstants}}
    <section class="summary" id="constants">
        <h2>Constants</h2>

        <dl class="properties">
            {{#class.constants}}
            {{>constant}}
            {{/class.constants}}
        </dl>
    </section>
    {{/class.hasConstants}}

    {{#class.hasStaticProperties}}
    <section class="summary" id="static-properties">
        <h2>Static Properties</h2>

        <dl class="properties">
            {{#class.staticProperties}}
            {{>property}}
            {{/class.staticProperties}}
        </dl>
    </section>
    {{/class.hasStaticProperties}}

    {{#class.hasStaticMethods}}
    <section class="summary" id="static-methods">
        <h2>Static Methods</h2>
        <dl class="callables">
            {{#class.staticMethods}}
            {{>callable}}
            {{/class.staticMethods}}
        </dl>
    </section>
    {{/class.hasStaticMethods}}

    {{#class.hasProperties}}
    <section class="summary" id="instance-properties">
        <h2>Properties</h2>

        <dl class="properties">
            {{#class.instanceProperties}}
            {{>property}}
            {{/class.instanceProperties}}

            {{#class.inheritedProperties}}
            {{>property}}
            {{/class.inheritedProperties}}
        </dl>
    </section>
    {{/class.hasProperties}}

    {{#class.hasConstructors}}
    <section class="summary" id="constructors">
        <h2>Constructors</h2>

        <dl class="constructor-summary-list">
            {{#class.constructors}}
            <dt id="{{htmlId}}" class="callable">
                <span class="name">{{{linkedName}}}</span><span class="signature">({{{ linkedParams }}})</span>
            </dt>
            <dd>
                {{#isConst}}
                <div class="constructor-modifier">
                    const
                </div>
                {{/isConst}}
                {{{ oneLineDoc }}}
            </dd>
            {{/class.constructors}}
        </dl>
      </section>
      {{/class.hasConstructors}}

      {{#class.hasOperators}}
      <section class="summary" id="operators">
          <h2>Operators</h2>
          <dl class="callables">
              {{#class.operators}}
              {{>callable}}
              {{/class.operators}}

              {{#class.inheritedOperators}}
              {{>callable}}
              {{/class.inheritedOperators}}
          </dl>
      </section>
      {{/class.hasOperators}}

      {{#class.hasMethods}}
      <section class="summary" id="instance-methods">
          <h2>Methods</h2>
          <dl class="callables">
              {{#class.instanceMethods}}
              {{>callable}}
              {{/class.instanceMethods}}

              {{#class.inheritedMethods}}
              {{>callable}}
              {{/class.inheritedMethods}}
          </dl>
      </section>
      {{/class.hasMethods}}

    </div> <!-- /.col-xs-12.col-sm-9 -->

</div> <!-- /.row-offcanvas -->

{{>footer}}