diff options
author | Marcin Aman <marcin.aman@gmail.com> | 2020-06-18 12:00:46 +0200 |
---|---|---|
committer | Błażej Kardyś <bkardys@virtuslab.com> | 2020-06-23 02:57:40 +0200 |
commit | 0206be47827e5b072dac3deb9ccc1792ba95b13c (patch) | |
tree | e00704bbb2a872e64b575c5f11ade21551a86535 /plugins/javadoc/src/main/resources | |
parent | ef2db3b74d2653c2f84eda4d7058ffcb546dae1d (diff) | |
download | dokka-0206be47827e5b072dac3deb9ccc1792ba95b13c.tar.gz dokka-0206be47827e5b072dac3deb9ccc1792ba95b13c.tar.bz2 dokka-0206be47827e5b072dac3deb9ccc1792ba95b13c.zip |
Javadoc classlikes and function pages
All implemented interfaces, first attempt at inherited methods
Diffstat (limited to 'plugins/javadoc/src/main/resources')
-rw-r--r-- | plugins/javadoc/src/main/resources/static_res/script.js | 139 | ||||
-rw-r--r-- | plugins/javadoc/src/main/resources/views/class.korte | 274 |
2 files changed, 412 insertions, 1 deletions
diff --git a/plugins/javadoc/src/main/resources/static_res/script.js b/plugins/javadoc/src/main/resources/static_res/script.js new file mode 100644 index 00000000..15fe6ac1 --- /dev/null +++ b/plugins/javadoc/src/main/resources/static_res/script.js @@ -0,0 +1,139 @@ +/* + * Copyright (c) 2013, 2018, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +var moduleSearchIndex; +var packageSearchIndex; +var typeSearchIndex; +var memberSearchIndex; +var tagSearchIndex; +function loadScripts(doc, tag) { + createElem(doc, tag, 'jquery/jszip/dist/jszip.js'); + createElem(doc, tag, 'jquery/jszip-utils/dist/jszip-utils.js'); + if (window.navigator.userAgent.indexOf('MSIE ') > 0 || window.navigator.userAgent.indexOf('Trident/') > 0 || + window.navigator.userAgent.indexOf('Edge/') > 0) { + createElem(doc, tag, 'jquery/jszip-utils/dist/jszip-utils-ie.js'); + } + createElem(doc, tag, 'search.js'); + + $.get(pathtoroot + "module-search-index.zip") + .done(function() { + JSZipUtils.getBinaryContent(pathtoroot + "module-search-index.zip", function(e, data) { + var zip = new JSZip(data); + zip.load(data); + moduleSearchIndex = JSON.parse(zip.file("module-search-index.json").asText()); + }); + }); + $.get(pathtoroot + "package-search-index.zip") + .done(function() { + JSZipUtils.getBinaryContent(pathtoroot + "package-search-index.zip", function(e, data) { + var zip = new JSZip(data); + zip.load(data); + packageSearchIndex = JSON.parse(zip.file("package-search-index.json").asText()); + }); + }); + $.get(pathtoroot + "type-search-index.zip") + .done(function() { + JSZipUtils.getBinaryContent(pathtoroot + "type-search-index.zip", function(e, data) { + var zip = new JSZip(data); + zip.load(data); + typeSearchIndex = JSON.parse(zip.file("type-search-index.json").asText()); + }); + }); + $.get(pathtoroot + "member-search-index.zip") + .done(function() { + JSZipUtils.getBinaryContent(pathtoroot + "member-search-index.zip", function(e, data) { + var zip = new JSZip(data); + zip.load(data); + memberSearchIndex = JSON.parse(zip.file("member-search-index.json").asText()); + }); + }); + $.get(pathtoroot + "tag-search-index.zip") + .done(function() { + JSZipUtils.getBinaryContent(pathtoroot + "tag-search-index.zip", function(e, data) { + var zip = new JSZip(data); + zip.load(data); + tagSearchIndex = JSON.parse(zip.file("tag-search-index.json").asText()); + }); + }); + if (!moduleSearchIndex) { + createElem(doc, tag, 'module-search-index.js'); + } + if (!packageSearchIndex) { + createElem(doc, tag, 'package-search-index.js'); + } + if (!typeSearchIndex) { + createElem(doc, tag, 'type-search-index.js'); + } + if (!memberSearchIndex) { + createElem(doc, tag, 'member-search-index.js'); + } + if (!tagSearchIndex) { + createElem(doc, tag, 'tag-search-index.js'); + } + $(window).resize(function() { + $('.navPadding').css('padding-top', $('.fixedNav').css("height")); + }); +} + +function createElem(doc, tag, path) { + var script = doc.createElement(tag); + var scriptElement = doc.getElementsByTagName(tag)[0]; + script.src = pathtoroot + path; + scriptElement.parentNode.insertBefore(script, scriptElement); +} + +function show(type) { + count = 0; + for (var key in data) { + var row = document.getElementById(key); + if ((data[key] & type) !== 0) { + row.style.display = ''; + row.className = (count++ % 2) ? rowColor : altColor; + } + else + row.style.display = 'none'; + } + updateTabs(type); +} + +function updateTabs(type) { + for (var value in tabs) { + var sNode = document.getElementById(tabs[value][0]); + var spanNode = sNode.firstChild; + if (value == type) { + sNode.className = activeTableTab; + spanNode.innerHTML = tabs[value][1]; + } + else { + sNode.className = tableTab; + spanNode.innerHTML = "<a href=\"javascript:show("+ value + ");\">" + tabs[value][1] + "</a>"; + } + } +} + +function updateModuleFrame(pFrame, cFrame) { + top.packageFrame.location = pFrame; + top.classFrame.location = cFrame; +} diff --git a/plugins/javadoc/src/main/resources/views/class.korte b/plugins/javadoc/src/main/resources/views/class.korte index 9b19df08..a9120fb2 100644 --- a/plugins/javadoc/src/main/resources/views/class.korte +++ b/plugins/javadoc/src/main/resources/views/class.korte @@ -1,2 +1,274 @@ {% extends "components/base.korte" %} -{% block content %} default {% end %}
\ No newline at end of file +{% block content %} + +<main role="main"> + <div class="header"> + <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">{{ package }}</a></div> + <h2 title="{{ kind|capitalize }} {{ name }}" class="title">{{ kind|capitalize }} {{ name }}</h2> + </div> + <div class="contentContainer"> + <!-- <ul class="inheritance"> + <li>java.lang.Object</li> + <li> + <ul class="inheritance"> + <li>adaptation.Adaptation</li> + </ul> + </li> + </ul> TODO inheritance tree --> + <div class="description"> + <ul class="blockList"> + <li class="blockList"> + {% if implementedInterfaces.size != 0 %} + <dl> + <dt>All Implemented Interfaces:</dt> + <dd> + {% for name in implementedInterfaces %} + <code>{{ name }}</code> + {% if !loop.last %} + , + {% endif %} + {% endfor %} + </dd> + </dl> + {% endif %} + <hr> + <pre>{{ signature|raw }}</pre> + <div class="block">{{ classlikeDocumentation }}</div> + </li> + </ul> + </div> + <div class="summary"> + <ul class="blockList"> + <li class="blockList"> + <!-- ======== NESTED CLASS SUMMARY ======== --> + {% if classlikes.size != 0 %} + <section role="region"> + <ul class="blockList"> + <li class="blockList"><a id="nested.class.summary"> + <!-- --> + </a> + <h3>Nested Class Summary</h3> + <table class="memberSummary"> + <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> + <tr> + <th class="colFirst" scope="col">Modifier and Type</th> + <th class="colSecond" scope="col">Class</th> + <th class="colLast" scope="col">Description</th> + </tr> + {% for classlike in classlikes %} + <tr class="{{ rowColor(loop.index0) }}"> + <td class="colFirst"><code>{{ classlike.modifiers }}</code></td> + <th class="colSecond" scope="row"><code>{{ classlike.signature }}</span></code> + </th> + <td class="colLast">{{ classlike.description }}</td> + </tr> + {% endfor %} + </table> + </li> + </ul> + </section> + {% endif %} + <!-- =========== FIELD SUMMARY =========== --> + {% if properties.size != 0 %} + <section role="region"> + <ul class="blockList"> + <li class="blockList"><a id="field.summary"> + <!-- --> + </a> + <h3>Field Summary</h3> + <table class="memberSummary"> + <caption><span>Fields</span><span class="tabEnd"> </span></caption> + <tr> + <th class="colFirst" scope="col">Modifier and Type</th> + <th class="colSecond" scope="col">Field</th> + <th class="colLast" scope="col">Description</th> + </tr> + {% for property in properties %} + <tr class="{{ rowColor(loop.index0) }}"> + <td class="colFirst"><code>{{ property.modifiers|raw }}</code></td> + <th class="colSecond" scope="row"><code>{{ property.signature|raw }}</code></th> + <td class="colLast">{{ description|raw }}</td> + </tr> + {% endfor %} + </table> + </li> + </ul> + </section> + {% endif %} + <!-- ======== CONSTRUCTOR SUMMARY ======== --> + {% if constructors.size != 0 %} + <section role="region"> + <ul class="blockList"> + <li class="blockList"><a id="constructor.summary"> + <!-- --> + </a> + <h3>Constructor Summary</h3> + <table class="memberSummary"> + <caption><span>Constructors</span><span class="tabEnd"> </span></caption> + <tbody> + <tr> + <th class="colFirst" scope="col">Constructor</th> + <th class="colLast" scope="col">Description</th> + </tr> + + {% for constructor in constructors %} + <tr class="{{ rowColor(loop.index0) }}"> + <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a + href="#%3Cinit%3E({{ constructor.inlineParameters }})">{{ constructor.name }}</a></span>({{ constructor.inlineParameters }})</code></th> + <td class="colLast">{{ constructor.brief }}</td> + </tr> + {% endfor %} + + </tbody> + </table> + </li> + </ul> + </section> + {% endif %} + <!-- =========== ENUM CONSTANT SUMMARY =========== --> + {% if entries.size != 0 %} + <section role="region"> + <ul class="blockList"> + <li class="blockList"><a id="enum.constant.summary"> + <!-- --> + </a> + <h3>Enum Constant Summary</h3> + <table class="memberSummary"> + <caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> + <tr> + <th class="colFirst" scope="col">Enum Constant</th> + <th class="colLast" scope="col">Description</th> + </tr> + {% for entry in entries %} + <tr class="{{ rowColor(loop.index0) }}"> + <th class="colFirst" scope="row"><code><span class="memberNameLink"><a + href="TODO">{{ entry.signature|raw }}</a></span></code></th> + <td class="colLast">{{ entry.brief }}</td> + </tr> + {% endfor %} + </table> + </li> + </ul> + </section> + {% endif %} + <!-- ========== METHOD SUMMARY =========== --> + {% if methods.own.size !=0 || methods.inherited.size != 0 %} + <section role="region"> + <ul class="blockList"> + <li class="blockList"><a id="method.summary"> + <!-- --> + </a> + <h3>Method Summary</h3> + <table class="memberSummary"> + <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span + class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a + href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span + id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span + class="tabEnd"> </span></span></caption> + <tbody> + <tr> + <th class="colFirst" scope="col">Modifier and Type</th> + <th class="colSecond" scope="col">Method</th> + <th class="colLast" scope="col">Description</th> + </tr> + {% for method in methods.own %} + <tr id="i{{ loop.index0 }}" class="{{ rowColor(loop.index0) }}"> + <td class="colFirst"><code>{{ method.modifiers|raw }}</code> + </td> + <th class="colSecond" scope="row"><code>{{ method.signatureWithoutModifiers|raw }} </code> + </th> + <td class="colLast">{{ method.brief|raw }}</td> + </tr> + {% endfor %} + </tbody> + </table> + <ul class="blockList"> + {% for method in methods.inherited %} + <li class="blockList"><a id="methods.inherited.from.class.{{ method.inheritedFrom}}"> + <!-- --> + </a> + <h3>Methods inherited from class {{ method.inheritedFrom}}</h3> + <code>{{ method.names }}</code></li> + {% endfor %} + <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> + <!-- --> + </a> + <h3>Methods inherited from class java.lang.Object</h3> + <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, + wait, wait, wait</code></li> + </ul> + </li> + </ul> + </section> + {% endif %} + </li> + </ul> + </div> + <div class="details"> + <ul class="blockList"> + <li class="blockList"> + <!-- ========= CONSTRUCTOR DETAIL ======== --> + {% if constructors.size != 0 %} + <section role="region"> + <ul class="blockList"> + <li class="blockList"><a id="constructor.detail"> + <!-- --> + </a> + <h3>Constructor Detail</h3> + {% for constructor in constructors %} + <a id="<{{ constructor.name }}>({{ constructor.inlineParameters }})"> + <!-- --> + </a> + <ul class="blockList"> + <li class="blockList"> + <h4>{{ constructor.name }}</h4> + <pre>{{ constructor.name }}({{ constructor.inlineParameters }})</pre> + <div class="block">{{ constructor.brief }}</div> + {% if constructor.parameters.size != 0 && hasAnyDescription(constructor.parameters) %} + <dl> + <dt><span class="paramLabel">Parameters:</span></dt> + {% for parameter in constructor.parameters %} + {% if parameter.description != "" %} + <dd><code>{{ parameter.name }}</code> - {{ parameter.description }}</dd> + {% endif %} + {% endfor %} + </dl> + {% endif %} + </li> + </ul> + {% endfor %} + </li> + </ul> + </section> + {% endif %} + <!-- ============ METHOD DETAIL ========== --> + {% if methods.own.size != 0 %} + <section role="region"> + <ul class="blockList"> + <li class="blockList"><a id="method.detail"> + <!-- --> + </a> + <h3>Method Detail</h3> + {% for method in methods.own %} + <a id="transform(model.ModelGraph,transformation.Transformation)"> + <!-- TODO --> + </a> + <ul class="blockListLast"> + <li class="blockList"> + <h4>{{ method.name }}</h4> + <pre class="methodSignature">{{ method.signature|raw }}</pre> + <div class="block">{{ method.brief|raw }}</div> + <!-- TODO missing return annotation --> + </li> + </ul> + {% endfor %} + </li> + </ul> + </section> + {% endif %} + </li> + </ul> + </div> + </div> +</main> +{% end %}
\ No newline at end of file |