aboutsummaryrefslogtreecommitdiff
path: root/doc-tool/resources/_layouts/api-page.html
blob: 1f5a441de3a9f8ff21f1cb7bd78ea6d1b8bad2c4 (plain) (blame)
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
---
layout: doc
extraCSS:
    - css/api-page.css
---

<div id="entity-container">
    <div id="entity-title">
        <span id="entity-modifiers">
            {{ entity.modifiers | join: " " }}
        </span>
        <span id="entity-kind">
            {{ entity.kind }}
        </span>
        <span id="entity-name">
            {{ entity.name }}
        </span>
    </div>

    {% if entity.comment.body %}
    <div id="entity-body" class="entity-section">
        {{ entity.comment.body }}
    </div>
    {% endif %}

    <h1 class="section">Members</h1>

    <div id="entity-members" class="entity-section">
        {% for member in entity.members %}
        <div class="member">
            <div class="member-title">
                <span class="member-annotations">
                    {% for annot in member.annotations %}@{{ annot | split: '.' | last }} {% endfor %}
                </span>
                <span class="member-modifiers">
                    {{ member.modifiers | join: " " }}
                </span>
                <span class="member-kind">
                    {{ member.kind }}
                </span>
                <span class="member-name">
                    {{ member.name }}
                </span>

                {% if member.kind == "def" and member.paramLists.size > 0 %}
                    {% for plist in member.paramLists %}
                    <span class="no-left">(</span>
                        {% if plist.isImplicit %}
                        <span class="no-left keyword">implicit</span>
                        {% endif %}
                        {% for ref in plist.list %}
                            {% if forloop.last %}
                            <span class="no-left">{{ ref.title }}</span>
                            {% else %}
                            <span class="no-left">{{ ref.title }}, </span>
                            {% endif %}
                        {% endfor %}
                    <span class="no-left">)</span>
                    {% endfor %}
                {% endif %}

                {% if member.returnValue %}
                <span class="no-left">: {{ member.returnValue.title }}</span>
                {% endif %}
            </div><!-- end member-title -->

            <div class="member-body">
                {{ member.comment.short }}
            </div>
        </div><!-- end member -->
        {% endfor %}
    </div>
</div><!-- end entity-container -->