peripheral/libupm/doxy/node/generators/yuidoc/tmpl/partials/module.handlebars


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92

<h1>{{name}} Module</h1>
<div class="box clearfix meta">
    {{#extra}}
        {{#selleck}}
            <a class="button link-docs" href="/yui/docs/{{name}}">User Guide &amp; Examples</a>
        {{/selleck}}
    {{/extra}}

    {{#if requires}}
        <div class="uses">
            Requires
            <ul class="inline commas">
                {{#requires}}
                    <li>{{#crossLinkModule .}}{{/crossLinkModule}}</li>
                {{/requires}}
            </ul>
        </div>
    {{/if}}

    {{#if foundAt}}
        <div class="foundat">
            Defined in: <a href="{{foundAt}}">`{{{file}}}:{{{line}}}`</a>
        </div>
    {{/if}}

    {{#if since}}
        <p>Available since {{since}}</p>
    {{/if}}
</div>

{{#if deprecated}}
    <div class="box deprecated">
        <p>
        {{#if deprecationMessage}}
            <strong>Deprecated:</strong> {{deprecationMessage}}
        {{else}}
            This module is deprecated.
        {{/if}}
        </p>
    </div>
{{/if}}

<div class="box intro">
    {{{moduleDescription}}}
</div>

{{#example}}
    <div class="example">
        <h4>Example:</h4>
        <div class="example-content">
            {{{.}}}
        </div>
    </div>
{{/example}}

<div class="yui3-g">
    <div class="yui3-u-1-2">
        {{#if moduleClasses}}
            <p>This module provides the following classes:</p>

            <ul class="module-classes">
            {{#moduleClasses}}
                <li class="module-class">
                    <a href="{{../projectRoot}}classes/{{name}}.html">
                        {{displayName}}
                    </a>
                </li>
            {{/moduleClasses}}
            </ul>
        {{/if}}
    </div>

    <div class="yui3-u-1-2">
        {{#if subModules}}
            <p>This module is a rollup of the following modules:</p>

            <ul class="module-submodules">
            {{#subModules}}
                <li class="module-submodule">
                    <a href="{{../projectRoot}}modules/{{name}}.html">
                        {{displayName}}
                    </a>

                    <div class="module-submodule-description">
                        {{{description}}}
                    </div>
                </li>
            {{/subModules}}
            </ul>
        {{/if}}
    </div>
</div>