diff options
Diffstat (limited to 'doc-tool/resources/_layouts')
-rw-r--r-- | doc-tool/resources/_layouts/api-page.html | 70 | ||||
-rw-r--r-- | doc-tool/resources/_layouts/doc.html | 6 |
2 files changed, 73 insertions, 3 deletions
diff --git a/doc-tool/resources/_layouts/api-page.html b/doc-tool/resources/_layouts/api-page.html new file mode 100644 index 000000000..41daf6c47 --- /dev/null +++ b/doc-tool/resources/_layouts/api-page.html @@ -0,0 +1,70 @@ +--- +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-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 --> diff --git a/doc-tool/resources/_layouts/doc.html b/doc-tool/resources/_layouts/doc.html index 78fc2b116..4fd615d23 100644 --- a/doc-tool/resources/_layouts/doc.html +++ b/doc-tool/resources/_layouts/doc.html @@ -8,17 +8,17 @@ layout: main <ul class="index-entities"> {% if docs.size > 0 %} <li class="index-title"> - <a href="{{ site.baseurl }}/api/index.html">API</a> + <span>API</span> </li> {% endif %} {% for pkg in docs %} <li class="index-entity entity-package"> - <a href="#">{{ pkg.name }}</a> + <a href="{{ site.baseurl }}/api/{{ pkg.path | join: "/" }}/index.html">{{ pkg.name }}</a> </li> {% for member in pkg.members %} {% if member.kind != "package" %} <li class="index-entity"> - <a href="#">{{ member.kind }} {{ member.name }}</a> + <a href="{{ site.baseurl }}/api/{{ member.path | join: "/" }}.html">{{ member.kind }} {{ member.name }}</a> </li> {% endif %} {% endfor %} |