azalea/kotlin-fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #40 from chirino/master

Browse Source 
Show the source code link when you hover over the members to simplify and declutter the normal doc navigation.
This commit is contained in:
James Strachan
2012-04-13 11:40:06 -07:00
parent 823c858634 954dcb49b4
commit ce12adfc7e
3 changed files with 26 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
libraries/docs/website/src/main/apidocs/js/apidoc.js
+8
View File
@@ -0,0 +1,8 @@
// This execute once the document loads.
$(function(){
$("div.source-detail").hide();
$("div.doc-member").hover(
function() { $(this).children("div.source-detail").show(); },
function() { $(this).children("div.source-detail").hide(); }
);
});
libraries/docs/website/src/main/apidocs/stylesheet.css
+7
View File
@@ -117,3 +117,10 @@ th, table { border-collapse:collapse;border-color: #E6E7E8; }
.NavBarCell2 { background-color:#FFFFFF;}
.NavBarCell3 { background-color:#FFFFFF;}
div.doc-member.function {
border-bottom: 1px solid #E6E7E8;
}
div.source-detail {
float:right;
}
libraries/tools/kdoc/src/main/kotlin/org/jetbrains/kotlin/doc/templates/PackageTemplateSupport.kt
Vendored
+11 -4
View File
@@ -119,6 +119,9 @@ abstract class PackageTemplateSupport(open val pkg: KPackage) : KDocTemplate() {
}
fun printFunctionDetail(function: KFunction): Unit {
println("""<div class="doc-member function">""")
println("""<div class="source-detail"><a href="${sourceHref(function)}"${function.sourceTargetAttribute()}>source</a></div>""")
println("""<A NAME="${function.name}{${function.parameterTypeText}}"><!-- --></A><A NAME="${function.link}"><!-- --></A><H3>""")
println("""${function.name}</H3>""")
println("""<PRE>""")
@@ -128,7 +131,7 @@ abstract class PackageTemplateSupport(open val pkg: KPackage) : KDocTemplate() {
printTypeParameters(function, " ")
printReceiverType(function, " ", ".", " ")
print("""<A HREF="${sourceHref(function)}"${function.sourceTargetAttribute()}><B>${function.name}</B></A>""")
print("""<B>${function.name}</B>""")
printParameters(function)
print(": ")
print(link(function.returnType))
@@ -160,7 +163,7 @@ abstract class PackageTemplateSupport(open val pkg: KPackage) : KDocTemplate() {
</DD>
</DL>
*/
println("""<HR>""")
println("""</div>""")
}
fun printPropertySummary(properties: Collection<KProperty>): Unit {
@@ -207,13 +210,17 @@ abstract class PackageTemplateSupport(open val pkg: KPackage) : KDocTemplate() {
}
*/
println("""</CODE></FONT></TD>""")
print("""<TD><CODE><B><A HREF="${sourceHref(property)}"${property.sourceTargetAttribute()}>${property.name}</A></B>: """)
print("""<TD>
<div class="doc-member property">
<div class="source-detail"><a HREF="${sourceHref(property)}"${property.sourceTargetAttribute()}>source</a></div>
<CODE><B>${property.name}</B>: """)
print(link(property.returnType))
//printParameters(property)
println("""</CODE>""")
println("""""")
println("""<BR>""")
println("""&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;${deprecated}&nbsp;${property.detailedDescription(this)}</TD>""")
println("""&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;${deprecated}&nbsp;${property.detailedDescription(this)}
</div></TD>""")
println("""</TR>""")
}