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

made the templates simpler avoiding the ugly \" escaping and using multi line strings by default

Browse Source
This commit is contained in:
James Strachan
2012-02-24 11:37:12 +00:00
parent fe97ed0155
commit 8795501f5a
10 changed files with 150 additions and 156 deletions
Download Patch File Download Diff File Expand all files Collapse all files
kdoc/src/main/kotlin/org/jetbrains/kotlin/doc/templates/AllClassesFrameTemplate.kt
Vendored
+7 -9
View File
@@ -13,14 +13,12 @@ class AllClassesFrameTemplate(val model: KModel, val classAttributes: String = "
println("""<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>""")
println("<!-- Generated by kdoc (${model.version}) on ${Date()} -->")
println("""<META http-equiv="Content-Type"
<HEAD>
<!-- Generated by kdoc (${model.version}) on ${Date()} -->
<META http-equiv="Content-Type"
content="text/html; charset=UTF-8">
<TITLE>""")
println("All Classes (${model.title})")
print("""</TITLE>
<TITLE>
All Classes (${model.title})</TITLE>
<META NAME="date" CONTENT="2012-01-09">
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
@@ -35,8 +33,8 @@ class AllClassesFrameTemplate(val model: KModel, val classAttributes: String = "
<TR>
<TD NOWRAP><FONT CLASS="FrameItemFont">""")
for (c in model.classes) {
println("<A HREF=\"${c.nameAsPath}.html\" title=\"class in ${c.packageName}\"$classAttributes>${c.simpleName}</A>")
println("<BR>")
println("""<A HREF="${c.nameAsPath}.html" title="class in ${c.packageName}"$classAttributes>${c.simpleName}</A>
<BR>""")
}
println("""</FONT></TD>
</TR>
kdoc/src/main/kotlin/org/jetbrains/kotlin/doc/templates/ClassExtensionsTemplate.kt
Vendored
+10 -14
View File
@@ -19,24 +19,20 @@ class ClassExtensionsTemplate(m: KModel, p: KPackage, k: KClass, var functions:
println("""<HR>
<!-- ======== START OF CLASS EXTENSIONS DATA ======== -->
<H2>
<FONT SIZE="-1">""")
println("${pkg.name}</FONT>")
println("<BR>")
println("Extensions on ${klass.name}</H2>")
println("<DL>")
print("<DT>")
print("extension functions on class <A HREF=\"${pkg.nameAsRelativePath}src-html/${klass.nameAsPath}.html#line.${klass.sourceLine}\"><B>${klass.name}</B></A><DT>")
println("from package ")
println(link(pkg))
println("</DL>")
println("""</PRE>
<FONT SIZE="-1">
${pkg.name}</FONT>
<BR>
Extensions on ${klass.name}</H2>
<DL>
<DT>
extension functions on class <A HREF="${pkg.nameAsRelativePath}src-html/${klass.nameAsPath}.html#line.${klass.sourceLine}"><B>${klass.name}</B></A><DT>
from package ${link(pkg)}
</DL>
</PRE>
<P>""")
printFunctionSummary(functions)
printFunctionDetail(functions)
println("""<!-- ========= END OF CLASS EXTENSIONS DATA ========= -->
<HR>
""")
kdoc/src/main/kotlin/org/jetbrains/kotlin/doc/templates/ClassTemplate.kt
Vendored
+49 -49
View File
@@ -21,7 +21,7 @@ open class ClassTemplate(open val model: KModel, pkg: KPackage, open val klass:
<!--NewPage-->
<HTML>
<HEAD>""")
println("<!-- Generated by kdoc (${model.version}) on ${Date()} -->")
println("""<!-- Generated by kdoc (${model.version}) on ${Date()} -->""")
println("""<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>""")
println(pageTitle())
@@ -29,13 +29,13 @@ open class ClassTemplate(open val model: KModel, pkg: KPackage, open val klass:
<META NAME="date" CONTENT="2012-01-09">
<META NAME="date" CONTENT="2012-01-09">""")
println("<LINK REL=\"stylesheet\" TYPE=\"text/css\" HREF=\"${pkg.nameAsRelativePath}stylesheet.css\" TITLE=\"Style\">")
println("""<LINK REL="stylesheet" TYPE="text/css" HREF="${pkg.nameAsRelativePath}stylesheet.css" TITLE="Style">""")
println("""
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {""")
println(" parent.document.title=\"${klass.name} (${model.title})\";")
println(""" parent.document.title="${klass.name} (${model.title})";""")
println(""" }
}
</SCRIPT>
@@ -57,14 +57,14 @@ function windowTitle()
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">""")
println(" <TD BGCOLOR=\"#EEEEFF\" CLASS=\"NavBarCell1\"> <A HREF=\"${pkg.nameAsRelativePath}overview-summary.html\"><FONT CLASS=\"NavBarFont1\"><B>Overview</B></FONT></A>&nbsp;</TD>")
println(" <TD BGCOLOR=\"#EEEEFF\" CLASS=\"NavBarCell1\"> <A HREF=\"package-summary.html\"><FONT CLASS=\"NavBarFont1\"><B>Package</B></FONT></A>&nbsp;</TD>")
println(" <TD BGCOLOR=\"#FFFFFF\" CLASS=\"NavBarCell1Rev\"> &nbsp;<FONT CLASS=\"NavBarFont1Rev\"><B>Class</B></FONT>&nbsp;</TD>")
println(" <TD BGCOLOR=\"#EEEEFF\" CLASS=\"NavBarCell1\"> <A HREF=\"class-use/${klass.simpleName}.html\"><FONT CLASS=\"NavBarFont1\"><B>Use</B></FONT></A>&nbsp;</TD>")
println(" <TD BGCOLOR=\"#EEEEFF\" CLASS=\"NavBarCell1\"> <A HREF=\"package-tree.html\"><FONT CLASS=\"NavBarFont1\"><B>Tree</B></FONT></A>&nbsp;</TD>")
println(" <TD BGCOLOR=\"#EEEEFF\" CLASS=\"NavBarCell1\"> <A HREF=\"${pkg.nameAsRelativePath}deprecated-list.html\"><FONT CLASS=\"NavBarFont1\"><B>Deprecated</B></FONT></A>&nbsp;</TD>")
println(" <TD BGCOLOR=\"#EEEEFF\" CLASS=\"NavBarCell1\"> <A HREF=\"${pkg.nameAsRelativePath}index-all.html\"><FONT CLASS=\"NavBarFont1\"><B>Index</B></FONT></A>&nbsp;</TD>")
println(" <TD BGCOLOR=\"#EEEEFF\" CLASS=\"NavBarCell1\"> <A HREF=\"${pkg.nameAsRelativePath}help-doc.html\"><FONT CLASS=\"NavBarFont1\"><B>Help</B></FONT></A>&nbsp;</TD>")
println(""" <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="${pkg.nameAsRelativePath}overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>""")
println(""" <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>""")
println(""" <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>""")
println(""" <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/${klass.simpleName}.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>""")
println(""" <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>""")
println(""" <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="${pkg.nameAsRelativePath}deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>""")
println(""" <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="${pkg.nameAsRelativePath}index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>""")
println(""" <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="${pkg.nameAsRelativePath}help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>""")
println(""" </TR>
</TABLE>
</TD>
@@ -78,17 +78,17 @@ function windowTitle()
printPrevNextClass()
println("""<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">""")
println(" <A HREF=\"${pkg.nameAsRelativePath}index.html?${klass.nameAsPath}.html\" target=\"_top\"><B>FRAMES</B></A> &nbsp;")
println("&nbsp;<A HREF=\"${klass.simpleName}.html\" target=\"_top\"><B>NO FRAMES</B></A> &nbsp;")
println(""" <A HREF="${pkg.nameAsRelativePath}index.html?${klass.nameAsPath}.html" target="_top"><B>FRAMES</B></A> &nbsp;""")
println("""&nbsp;<A HREF="${klass.simpleName}.html" target="_top"><B>NO FRAMES</B></A> &nbsp;""")
println("""&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {""")
println(" document.writeln('<A HREF=\"${pkg.nameAsRelativePath}allclasses-noframe.html\"><B>All Classes</B></A>');")
println(""" document.writeln('<A HREF="${pkg.nameAsRelativePath}allclasses-noframe.html"><B>All Classes</B></A>');""")
println(""" }
//-->
</SCRIPT>
<NOSCRIPT>""")
println(" <A HREF=\"${pkg.nameAsRelativePath}allclasses-noframe.html\"><B>All Classes</B></A>")
println(""" <A HREF="${pkg.nameAsRelativePath}allclasses-noframe.html"><B>All Classes</B></A>""")
println("""</NOSCRIPT>
@@ -117,14 +117,14 @@ DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHO
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">""")
println(" <TD BGCOLOR=\"#EEEEFF\" CLASS=\"NavBarCell1\"> <A HREF=\"${pkg.nameAsRelativePath}overview-summary.html\"><FONT CLASS=\"NavBarFont1\"><B>Overview</B></FONT></A>&nbsp;</TD>")
println(" <TD BGCOLOR=\"#EEEEFF\" CLASS=\"NavBarCell1\"> <A HREF=\"package-summary.html\"><FONT CLASS=\"NavBarFont1\"><B>Package</B></FONT></A>&nbsp;</TD>")
println(" <TD BGCOLOR=\"#FFFFFF\" CLASS=\"NavBarCell1Rev\"> &nbsp;<FONT CLASS=\"NavBarFont1Rev\"><B>Class</B></FONT>&nbsp;</TD>")
println(" <TD BGCOLOR=\"#EEEEFF\" CLASS=\"NavBarCell1\"> <A HREF=\"class-use/${klass.simpleName}.html\"><FONT CLASS=\"NavBarFont1\"><B>Use</B></FONT></A>&nbsp;</TD>")
println(" <TD BGCOLOR=\"#EEEEFF\" CLASS=\"NavBarCell1\"> <A HREF=\"package-tree.html\"><FONT CLASS=\"NavBarFont1\"><B>Tree</B></FONT></A>&nbsp;</TD>")
println(" <TD BGCOLOR=\"#EEEEFF\" CLASS=\"NavBarCell1\"> <A HREF=\"${pkg.nameAsRelativePath}deprecated-list.html\"><FONT CLASS=\"NavBarFont1\"><B>Deprecated</B></FONT></A>&nbsp;</TD>")
println(" <TD BGCOLOR=\"#EEEEFF\" CLASS=\"NavBarCell1\"> <A HREF=\"${pkg.nameAsRelativePath}index-all.html\"><FONT CLASS=\"NavBarFont1\"><B>Index</B></FONT></A>&nbsp;</TD>")
println(" <TD BGCOLOR=\"#EEEEFF\" CLASS=\"NavBarCell1\"> <A HREF=\"${pkg.nameAsRelativePath}help-doc.html\"><FONT CLASS=\"NavBarFont1\"><B>Help</B></FONT></A>&nbsp;</TD>")
println(""" <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="${pkg.nameAsRelativePath}overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>""")
println(""" <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>""")
println(""" <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>""")
println(""" <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/${klass.simpleName}.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>""")
println(""" <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>""")
println(""" <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="${pkg.nameAsRelativePath}deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>""")
println(""" <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="${pkg.nameAsRelativePath}index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>""")
println(""" <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="${pkg.nameAsRelativePath}help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>""")
println(""" </TR>
</TABLE>
@@ -137,17 +137,17 @@ DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHO
<TR>""")
printPrevNextClass()
println("""<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">""")
println(" <A HREF=\"${pkg.nameAsRelativePath}index.html?${klass.nameAsPath}.html\" target=\"_top\"><B>FRAMES</B></A> &nbsp;")
println("&nbsp;<A HREF=\"${klass.simpleName}.html\" target=\"_top\"><B>NO FRAMES</B></A> &nbsp;")
println(""" <A HREF="${pkg.nameAsRelativePath}index.html?${klass.nameAsPath}.html" target="_top"><B>FRAMES</B></A> &nbsp;""")
println("""&nbsp;<A HREF="${klass.simpleName}.html" target="_top"><B>NO FRAMES</B></A> &nbsp;""")
println("""&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {""")
println(" document.writeln('<A HREF=\"${pkg.nameAsRelativePath}allclasses-noframe.html\"><B>All Classes</B></A>');")
println(""" document.writeln('<A HREF="${pkg.nameAsRelativePath}allclasses-noframe.html"><B>All Classes</B></A>');""")
println(""" }
//-->
</SCRIPT>
<NOSCRIPT>""")
println(" <A HREF=\"${pkg.nameAsRelativePath}allclasses-noframe.html\"><B>All Classes</B></A>")
println(""" <A HREF="${pkg.nameAsRelativePath}allclasses-noframe.html"><B>All Classes</B></A>""")
println("""</NOSCRIPT>
@@ -174,44 +174,44 @@ DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHO
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">""")
println("${pkg.name}</FONT>")
println("<BR>")
println("Class ${klass.simpleName}</H2>")
println("<PRE>")
println("""${pkg.name}</FONT>""")
println("""<BR>""")
println("""Class ${klass.simpleName}</H2>""")
println("""<PRE>""")
for (bc in klass.baseClasses) {
println(link(bc, true))
}
println(" <IMG SRC=\"${pkg.nameAsRelativePath}resources/inherit.gif\" ALT=\"extended by \"><B>${klass.name}</B>")
println(""" <IMG SRC="${pkg.nameAsRelativePath}resources/inherit.gif" ALT="extended by "><B>${klass.name}</B>""")
println("""</PRE>
<HR>
<DL>""")
print("<DT><PRE><FONT SIZE=\"-1\">")
print("""<DT><PRE><FONT SIZE="-1">""")
printAnnotations(klass.annotations)
print("</FONT>public class <A HREF=\"${pkg.nameAsRelativePath}src-html/${klass.nameAsPath}.html#line.${klass.sourceLine}\"><B>${klass.simpleName}</B></A><DT>")
print("""</FONT>public class <A HREF="${pkg.nameAsRelativePath}src-html/${klass.nameAsPath}.html#line.${klass.sourceLine}"><B>${klass.simpleName}</B></A><DT>""")
if (!klass.baseClasses.isEmpty()) {
print("extends ")
print("""extends """)
for (bc in klass.baseClasses) {
println(link(bc))
}
}
println("</DL>")
println("""</DL>""")
println("""</PRE>
<P>""")
println(klass.detailedDescription)
if (klass.since.size > 0 || klass.authors.size > 0) {
println("<P>")
println("<DL>")
println("""<P>""")
println("""<DL>""")
if (klass.since.size > 0) {
println("<DT><B>Since:</B></DT>")
println(" <DD>${klass.since}</DD>")
println("""<DT><B>Since:</B></DT>""")
println(""" <DD>${klass.since}</DD>""")
}
for (author in klass.authors) {
println("<DT><B>Author:</B></DT>")
println(" <DD>${author}</DD>")
println("""<DT><B>Author:</B></DT>""")
println(""" <DD>${author}</DD>""")
}
println("</DL>")
println("""</DL>""")
}
println("""<HR>
@@ -231,10 +231,10 @@ DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHO
println("""<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;class</CODE></FONT></TD>""")
println("<TD><CODE><B><A HREF=\"${pkg.nameAsRelativePath}${nc.nameAsPath}.html\" title=\"class in ${nc.packageName}\">${klass.simpleName}.${nc.simpleName}</A></B></CODE>")
println("<BR>")
println("&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;${nc.description}")
println("</TD>")
println("""<TD><CODE><B><A HREF="${pkg.nameAsRelativePath}${nc.nameAsPath}.html" title="class in ${nc.packageName}">${klass.simpleName}.${nc.simpleName}</A></B></CODE>""")
println("""<BR>""")
println("""&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;${nc.description}""")
println("""</TD>""")
}
println("""</TR>
</TABLE>
@@ -254,12 +254,12 @@ DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHO
println("""<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">""")
val prev = pkg.previous(klass)
if (prev != null) {
println("&nbsp;<A HREF=\"${pkg.nameAsRelativePath}${prev.nameAsPath}.html\" title=\"class in ${prev.packageName}\"><B>PREV CLASS</B></A>&nbsp;")
println("""&nbsp;<A HREF="${pkg.nameAsRelativePath}${prev.nameAsPath}.html" title="class in ${prev.packageName}"><B>PREV CLASS</B></A>&nbsp;""")
}
val next = pkg.next(klass)
if (next != null) {
println("&nbsp;<A HREF=\"${pkg.nameAsRelativePath}${next.nameAsPath}.html\" title=\"class in ${next.packageName}\"><B>NEXT CLASS</B></A>")
println("""&nbsp;<A HREF="${pkg.nameAsRelativePath}${next.nameAsPath}.html" title="class in ${next.packageName}"><B>NEXT CLASS</B></A>""")
}
println("""</FONT></TD>""")
}
kdoc/src/main/kotlin/org/jetbrains/kotlin/doc/templates/HelpDocTemplate.kt
Vendored
+2 -2
View File
@@ -16,7 +16,7 @@ class HelpDocTemplate(val model: KModel) : KDocTemplate() {
<!-- Generated by javadoc on Mon Jan 09 13:32:00 EST 2012-->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>""")
println("API Help (${model.title})")
println("""API Help (${model.title})""")
println("""</TITLE>
<META NAME="date" CONTENT="2012-01-09">
@@ -27,7 +27,7 @@ class HelpDocTemplate(val model: KModel) : KDocTemplate() {
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {""")
println(" parent.document.title=\"API Help (${model.title})\";")
println(""" parent.document.title="API Help (${model.title})";""")
println(""" }
}
</SCRIPT>
kdoc/src/main/kotlin/org/jetbrains/kotlin/doc/templates/OverviewFrameTemplate.kt
Vendored
+4 -4
View File
@@ -14,10 +14,10 @@ class OverviewFrameTemplate(val model: KModel) : KDocTemplate() {
<!--NewPage-->
<HTML>
<HEAD>""")
println("<!-- Generated by kdoc (${model.version}) on ${Date()} -->")
println("""<!-- Generated by kdoc (${model.version}) on ${Date()} -->""")
println("""<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>""")
println("Overview List (${model.title})")
println("""Overview List (${model.title})""")
print("""</TITLE>
<META NAME="date" CONTENT="2012-01-09">
@@ -41,8 +41,8 @@ class OverviewFrameTemplate(val model: KModel) : KDocTemplate() {
Packages</FONT>
<BR>""")
for (p in model.packages) {
println("<FONT CLASS=\"FrameItemFont\"><A HREF=\"${p.nameAsPath}/package-frame.html\" target=\"packageFrame\">${p.name}</A></FONT>")
println("<BR>")
println("""<FONT CLASS="FrameItemFont"><A HREF="${p.nameAsPath}/package-frame.html" target="packageFrame">${p.name}</A></FONT>""")
println("""<BR>""")
}
println("""</TD>
</TR>
kdoc/src/main/kotlin/org/jetbrains/kotlin/doc/templates/OverviewSummaryTemplate.kt
Vendored
+6 -6
View File
@@ -16,7 +16,7 @@ class OverviewSummaryTemplate(val model: KModel) : KDocTemplate() {
<!-- Generated by javadoc on Mon Jan 09 13:32:00 EST 2012-->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>""")
println("Overview (${model.title})")
println("""Overview (${model.title})""")
println("""</TITLE>
<META NAME="date" CONTENT="2012-01-09">
@@ -27,7 +27,7 @@ class OverviewSummaryTemplate(val model: KModel) : KDocTemplate() {
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {""")
println(" parent.document.title=\"Overview (${model.title})\";")
println(""" parent.document.title="Overview (${model.title})";""")
println(""" }
}
</SCRIPT>
@@ -103,10 +103,10 @@ function windowTitle()
<B>Packages</B></FONT></TH>
</TR>""")
for (p in model.packages) {
println("<TR BGCOLOR=\"white\" CLASS=\"TableRowColor\">")
println("<TD WIDTH=\"20%\"><B><A HREF=\"${p.nameAsPath}/package-summary.html\">${p.nameAsPath}</A></B></TD>")
println("<TD>${p.description}</TD>")
println("</TR>")
println("""<TR BGCOLOR="white" CLASS="TableRowColor">""")
println("""<TD WIDTH="20%"><B><A HREF="${p.nameAsPath}/package-summary.html">${p.nameAsPath}</A></B></TD>""")
println("""<TD>${p.description}</TD>""")
println("""</TR>""")
}
println("""</TABLE>
kdoc/src/main/kotlin/org/jetbrains/kotlin/doc/templates/OverviewTreeTemplate.kt
Vendored
+4 -4
View File
@@ -16,7 +16,7 @@ class OverviewTreeTemplate(val model: KModel) : KDocTemplate() {
<!-- Generated by javadoc on Mon Jan 09 13:32:00 EST 2012-->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>""")
println("Class Hierarchy (${model.title})")
println("""Class Hierarchy (${model.title})""")
println("""</TITLE>
<META NAME="date" CONTENT="2012-01-09">
@@ -27,7 +27,7 @@ class OverviewTreeTemplate(val model: KModel) : KDocTemplate() {
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {""")
println(" parent.document.title=\"Class Hierarchy (${model.title})\";")
println(""" parent.document.title="Class Hierarchy (${model.title})";""")
println(""" }
}
</SCRIPT>
@@ -103,8 +103,8 @@ Hierarchy For All Packages</H2>
if (first) {
first = false
} else {
print(", ")
print("<A HREF=\"${p.nameAsPath}/package-tree.html\">${p.nameAsPath}</A>")
print(""", """)
print("""<A HREF="${p.nameAsPath}/package-tree.html">${p.nameAsPath}</A>""")
}
}
println("""</DL>
kdoc/src/main/kotlin/org/jetbrains/kotlin/doc/templates/PackageFrameTemplate.kt
Vendored
+10 -10
View File
@@ -18,20 +18,20 @@ class PackageFrameTemplate(val model: KModel, p: KPackage) : PackageTemplateSupp
<!--NewPage-->
<HTML>
<HEAD>""")
println("<!-- Generated by kdoc (${model.version}) on ${Date()} -->")
println("""<!-- Generated by kdoc (${model.version}) on ${Date()} -->""")
println("""<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>""")
println("${pkg.name} (${model.title})")
println("""${pkg.name} (${model.title})""")
println("""</TITLE>
<META NAME="date" CONTENT="2012-01-09">""")
println("<LINK REL =\"stylesheet\" TYPE=\"text/css\" HREF=\"${pkg.nameAsRelativePath}stylesheet.css\" TITLE=\"Style\">")
println("""<LINK REL ="stylesheet" TYPE="text/css" HREF="${pkg.nameAsRelativePath}stylesheet.css" TITLE="Style">""")
println("""
</HEAD>
<BODY BGCOLOR="white">
<FONT size="+1" CLASS="FrameTitleFont">""")
println("<A HREF=\"${pkg.nameAsRelativePath}${pkg.nameAsPath}/package-summary.html\" target=\"classFrame\">${pkg.name}</A></FONT>")
println("""<A HREF="${pkg.nameAsRelativePath}${pkg.nameAsPath}/package-summary.html" target="classFrame">${pkg.name}</A></FONT>""")
printClasses("interface", "Interfaces")
printClasses("class", "Classes")
@@ -57,8 +57,8 @@ class PackageFrameTemplate(val model: KModel, p: KPackage) : PackageTemplateSupp
<BR>""")
for (c in classes) {
val formatted = if (kind == "interface") "<I>${c.simpleName}</I>" else c.simpleName
println("<A HREF=\"${c.simpleName}.html\" title=\"$kind in ${pkg.name}\" target=\"classFrame\">$formatted</A>")
println("<BR>")
println("""<A HREF="${c.simpleName}.html" title="$kind in ${pkg.name}" target="classFrame">$formatted</A>""")
println("""<BR>""")
}
println("""</TR>
</TABLE>""")
@@ -74,8 +74,8 @@ class PackageFrameTemplate(val model: KModel, p: KPackage) : PackageTemplateSupp
<FONT CLASS="FrameItemFont">
<BR>""")
for (c in functions) {
println("<A HREF=\"${href(c)}\" title=\"function in ${pkg.name}\" target=\"classFrame\"><I>${c.name}</I></A>")
println("<BR>")
println("""<A HREF="${href(c)}" title="function in ${pkg.name}" target="classFrame"><I>${c.name}</I></A>""")
println("""<BR>""")
}
println("""</TR>
</TABLE>""")
@@ -93,8 +93,8 @@ class PackageFrameTemplate(val model: KModel, p: KPackage) : PackageTemplateSupp
for (e in map.entrySet()) {
val c = e?.getKey()
if (c != null) {
println("<A HREF=\"${extensionsHref(pkg, c)}\" title=\"extensions functions on class ${c.name} from ${pkg.name}\" target=\"classFrame\"><I>${c.name}</I></A>")
println("<BR>")
println("""<A HREF="${extensionsHref(pkg, c)}" title="extensions functions on class ${c.name} from ${pkg.name}" target="classFrame"><I>${c.name}</I></A>""")
println("""<BR>""")
}
}
println("""</TR>
kdoc/src/main/kotlin/org/jetbrains/kotlin/doc/templates/PackageSummaryTemplate.kt
Vendored
+33 -33
View File
@@ -17,21 +17,21 @@ class PackageSummaryTemplate(val model: KModel, pkg: KPackage) : PackageTemplate
<!--NewPage-->
<HTML>
<HEAD>""")
println("<!-- Generated by kdoc (${model.version}) on ${Date()} -->")
println("""<!-- Generated by kdoc (${model.version}) on ${Date()} -->""")
println("""<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>""")
println("${pkg.name} (${model.title})")
println("""${pkg.name} (${model.title})""")
println("""</TITLE>
<META NAME="date" CONTENT="2012-01-09">
<META NAME="date" CONTENT="2012-01-09">""")
println("<LINK REL=\"stylesheet\" TYPE=\"text/css\" HREF=\"${pkg.nameAsRelativePath}stylesheet.css\" TITLE=\"Style\">")
println("""<LINK REL="stylesheet" TYPE="text/css" HREF="${pkg.nameAsRelativePath}stylesheet.css" TITLE="Style">""")
println("""
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {""")
println(" parent.document.title=\"${pkg.name} (${model.title})\";")
println(""" parent.document.title="${pkg.name} (${model.title})";""")
println(""" }
}
</SCRIPT>
@@ -54,15 +54,15 @@ function windowTitle()
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">""")
println("<TD BGCOLOR=\"#EEEEFF\" CLASS=\"NavBarCell1\"> <A HREF=\"${pkg.nameAsRelativePath}overview-summary.html\"><FONT CLASS=\"NavBarFont1\"><B>Overview</B></FONT></A>&nbsp;</TD>")
println("""<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="${pkg.nameAsRelativePath}overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>""")
println("""<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>""")
println("<TD BGCOLOR=\"#EEEEFF\" CLASS=\"NavBarCell1\"> <A HREF=\"${pkg.nameAsRelativePath}deprecated-list.html\"><FONT CLASS=\"NavBarFont1\"><B>Deprecated</B></FONT></A>&nbsp;</TD>")
println("<TD BGCOLOR=\"#EEEEFF\" CLASS=\"NavBarCell1\"> <A HREF=\"${pkg.nameAsRelativePath}index-all.html\"><FONT CLASS=\"NavBarFont1\"><B>Index</B></FONT></A>&nbsp;</TD>")
println("<TD BGCOLOR=\"#EEEEFF\" CLASS=\"NavBarCell1\"> <A HREF=\"${pkg.nameAsRelativePath}help-doc.html\"><FONT CLASS=\"NavBarFont1\"><B>Help</B></FONT></A>&nbsp;</TD>")
println("""<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="${pkg.nameAsRelativePath}deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>""")
println("""<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="${pkg.nameAsRelativePath}index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>""")
println("""<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="${pkg.nameAsRelativePath}help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>""")
println(""" </TR>
</TABLE>
</TD>
@@ -75,17 +75,17 @@ function windowTitle()
printNextPrevPackages()
println("""<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">""")
println(" <A HREF=\"${pkg.nameAsRelativePath}index.html?${pkg.nameAsPath}/package-summary.html\" target=\"_top\"><B>FRAMES</B></A> &nbsp;")
println(""" <A HREF="${pkg.nameAsRelativePath}index.html?${pkg.nameAsPath}/package-summary.html" target="_top"><B>FRAMES</B></A> &nbsp;""")
println("""&nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {""")
println(" document.writeln('<A HREF=\"${pkg.nameAsRelativePath}allclasses-noframe.html\"><B>All Classes</B></A>');")
println(""" document.writeln('<A HREF="${pkg.nameAsRelativePath}allclasses-noframe.html"><B>All Classes</B></A>');""")
println(""" }
//-->
</SCRIPT>
<NOSCRIPT>""")
println(" <A HREF=\"${pkg.nameAsRelativePath}allclasses-noframe.html\"><B>All Classes</B></A>")
println(""" <A HREF="${pkg.nameAsRelativePath}allclasses-noframe.html"><B>All Classes</B></A>""")
println("""</NOSCRIPT>
@@ -101,12 +101,12 @@ function windowTitle()
for (a in pkg.annotations) {
val url = a.url
if (url != null) {
println("<A HREF=\"$url?is-external=true\" title=\"class or interface in ${a.packageName}\">@${a.simpleName}</A>")
println("""<A HREF="$url?is-external=true" title="class or interface in ${a.packageName}">@${a.simpleName}</A>""")
}
}
println("</FONT><H2>")
println("Package ${pkg.name}")
println("</H2>")
println("""</FONT><H2>""")
println("""Package ${pkg.name}""")
println("""</H2>""")
println(pkg.description)
println("""<P>
<B>See:</B>
@@ -125,7 +125,7 @@ function windowTitle()
printExtensionFunctions()
println("""<A NAME="package_description"><!-- --></A><H2>""")
println("Package ${pkg.name} Description")
println("""Package ${pkg.name} Description""")
println("""</H2>
<P>""")
@@ -142,17 +142,17 @@ function windowTitle()
val group = e?.getKey() ?: "Other"
val list = e?.getValue()
if (list != null) {
println(" <h3>$group</h3>")
println(""" <h3>$group</h3>""")
println("""
<ul>""")
for (c in list) {
println(" <li><A HREF=\"${pkg.nameAsRelativePath}${c.nameAsPath}.html\" title=\"class in ${pkg.name}\"><CODE>${c.simpleName}</CODE></A>")
println(""" <li><A HREF="${pkg.nameAsRelativePath}${c.nameAsPath}.html" title="class in ${pkg.name}"><CODE>${c.simpleName}</CODE></A>""")
}
println("""
</ul>""")
}
}
println("<P>")
println("""<P>""")
printFunctionDetail(pkg.packageFunctions())
@@ -194,7 +194,7 @@ function windowTitle()
printNextPrevPackages()
println("""<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">""")
println(") <A HREF=\"${pkg.nameAsRelativePath}index.html?${pkg.nameAsPath}/package-summary.html\" target=\"_top\"><B>FRAMES</B></A> &nbsp;")
println(""") <A HREF="${pkg.nameAsRelativePath}index.html?${pkg.nameAsPath}/package-summary.html" target="_top"><B>FRAMES</B></A> &nbsp;""")
println("""&nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
@@ -228,14 +228,14 @@ Copyright &#169; 2010-2012. All Rights Reserved.
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">""")
println("<B>$description Summary</B></FONT></TH>")
println("""<B>$description Summary</B></FONT></TH>""")
println("""</TR>""")
for (c in classes) {
println("""<TR BGCOLOR="white" CLASS="TableRowColor">""")
println("<TD WIDTH=\"15%\"><B><A HREF=\"${pkg.nameAsRelativePath}${c.nameAsPath}.html\" title=\"$kind in ${pkg.name}\">${c.simpleName}</A></B></TD>")
println("<TD>${c.description}</TD>")
println("</TR>")
println("""<TD WIDTH="15%"><B><A HREF="${pkg.nameAsRelativePath}${c.nameAsPath}.html" title="$kind in ${pkg.name}">${c.simpleName}</A></B></TD>""")
println("""<TD>${c.description}</TD>""")
println("""</TR>""")
}
println("""</TABLE>
&nbsp;
@@ -256,9 +256,9 @@ Copyright &#169; 2010-2012. All Rights Reserved.
for (f in functions) {
println("""<TR BGCOLOR="white" CLASS="TableRowColor">""")
println("<TD WIDTH=\"15%\"><B><A HREF=\"${href(f)}\" title=\"function in ${pkg.name}\">${f.name}</A></B></TD>")
println("<TD>${f.description}</TD>")
println("</TR>")
println("""<TD WIDTH="15%"><B><A HREF="${href(f)}" title="function in ${pkg.name}">${f.name}</A></B></TD>""")
println("""<TD>${f.description}</TD>""")
println("""</TR>""")
}
println("""</TABLE>
&nbsp;
@@ -281,16 +281,16 @@ Copyright &#169; 2010-2012. All Rights Reserved.
val c = e?.getKey()
if (c != null) {
println("""<TR BGCOLOR="white" CLASS="TableRowColor">""")
println("<TD WIDTH=\"15%\"><B><A HREF=\"${pkg.nameAsRelativePath}${c.name}.html\" title=\"extensions on ${pkg.name}\">${c.name}</A></B></TD>")
print("<TD>")
println("""<TD WIDTH="15%"><B><A HREF="${pkg.nameAsRelativePath}${c.name}.html" title="extensions on ${pkg.name}">${c.name}</A></B></TD>""")
print("""<TD>""")
val list = e?.getValue()
if (list != null) {
for (f in list) {
println("""<A HREF="${extensionsHref(pkg, c, f)}">${f.name}<A> """)
}
}
println("</TD>")
println("</TR>")
println("""</TD>""")
println("""</TR>""")
}
}
println("""</TABLE>
@@ -306,11 +306,11 @@ Copyright &#169; 2010-2012. All Rights Reserved.
println("""<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">""")
val prev = model.previous(pkg)
if (prev != null) {
println("&nbsp;<A HREF=\"${prev.nameAsRelativePath}${prev.nameAsPath}/package-summary.html\"><B>PREV PACKAGE</B></A>&nbsp;")
println("""&nbsp;<A HREF="${prev.nameAsRelativePath}${prev.nameAsPath}/package-summary.html"><B>PREV PACKAGE</B></A>&nbsp;""")
}
val next = model.next(pkg)
if (next != null) {
println("&nbsp;<A HREF=\"${next.nameAsRelativePath}${next.nameAsPath}/package-summary.html\"><B>NEXT PACKAGE</B></A>")
println("""&nbsp;<A HREF="${next.nameAsRelativePath}${next.nameAsPath}/package-summary.html"><B>NEXT PACKAGE</B></A>""")
}
println("""</FONT></TD>""")
kdoc/src/main/kotlin/org/jetbrains/kotlin/doc/templates/PackageTemplateSupport.kt
Vendored
+25 -25
View File
@@ -50,7 +50,7 @@ abstract class PackageTemplateSupport(open val pkg: KPackage) : KDocTemplate() {
<TD NOWRAP><FONT SIZE="-1">
<CODE>""")
printTypeParameters(method)
println("<BR>")
println("""<BR>""")
print(link(method.returnType))
println("""</CODE></FONT></TD>
</TR>
@@ -58,14 +58,14 @@ abstract class PackageTemplateSupport(open val pkg: KPackage) : KDocTemplate() {
} else {
print(link(method.returnType))
}
println("</CODE></FONT></TD>")
print("<TD><CODE><B><A HREF=\"${href(method)}\">${method.name}</A></B>")
println("""</CODE></FONT></TD>""")
print("""<TD><CODE><B><A HREF="${href(method)}">${method.name}</A></B>""")
printParameters(method)
println("</CODE>")
println("")
println("<BR>")
println("&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;${deprecated}&nbsp;${method.detailedDescription}</TD>")
println("</TR>")
println("""</CODE>""")
println("""""")
println("""<BR>""")
println("""&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;${deprecated}&nbsp;${method.detailedDescription}</TD>""")
println("""</TR>""")
}
fun printFunctionDetail(functions: Collection<KFunction>): Unit {
@@ -90,27 +90,27 @@ abstract class PackageTemplateSupport(open val pkg: KPackage) : KDocTemplate() {
}
fun printFunctionDetail(function: KFunction): Unit {
println("<A NAME=\"${function.name}{${function.parameterTypeText}})\"><!-- --></A><A NAME=\"${function.name}(${function.typeParametersText})\"><!-- --></A><H3>")
println("${function.name}</H3>")
println("<PRE>")
println("<FONT SIZE=\"-1\">")
println("""<A NAME="${function.name}{${function.parameterTypeText}})"><!-- --></A><A NAME="${function.name}(${function.typeParametersText})"><!-- --></A><H3>""")
println("""${function.name}</H3>""")
println("""<PRE>""")
println("""<FONT SIZE="-1">""")
printAnnotations(function.annotations)
print("</FONT>${function.modifiers.join(" ")} ")
print("""</FONT>${function.modifiers.join(" ")} """)
printTypeParameters(function)
print(link(function.returnType))
print(" <A HREF=\"${sourceHref(function)}\"><B>${function.name}</B></A>")
print(""" <A HREF="${sourceHref(function)}"><B>${function.name}</B></A>""")
printParameters(function)
val exlist = function.exceptions
var first = true
if (!exlist.isEmpty()) {
println(" throws ");
println(""" throws """);
for (ex in exlist) {
if (first) first = false else print(", ")
print(link(ex))
}
}
println("</PRE>")
println("""</PRE>""")
println(function.detailedDescription)
/* TODO
@@ -128,7 +128,7 @@ abstract class PackageTemplateSupport(open val pkg: KPackage) : KDocTemplate() {
</DD>
</DL>
*/
println("<HR>")
println("""<HR>""")
}
fun printPropertySummary(properties: Collection<KProperty>): Unit {
@@ -164,7 +164,7 @@ abstract class PackageTemplateSupport(open val pkg: KPackage) : KDocTemplate() {
<TD NOWRAP><FONT SIZE="-1">
<CODE>""")
printTypeParameters(property)
println("<BR>")
println("""<BR>""")
print(link(property.returnType))
println("""</CODE></FONT></TD>
</TR>
@@ -174,14 +174,14 @@ abstract class PackageTemplateSupport(open val pkg: KPackage) : KDocTemplate() {
}
*/
print(link(property.returnType))
println("</CODE></FONT></TD>")
print("<TD><CODE><B><A HREF=\"${href(property)}\">${property.name}</A></B>")
println("""</CODE></FONT></TD>""")
print("""<TD><CODE><B><A HREF="${href(property)}">${property.name}</A></B>""")
//printParameters(property)
println("</CODE>")
println("")
println("<BR>")
println("&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;${deprecated}&nbsp;${property.detailedDescription}</TD>")
println("</TR>")
println("""</CODE>""")
println("""""")
println("""<BR>""")
println("""&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;${deprecated}&nbsp;${property.detailedDescription}</TD>""")
println("""</TR>""")
}
fun printTypeParameters(method: KFunction): Unit {