diff --git a/kdoc/src/main/kotlin/org/jetbrains/kotlin/doc/KDoc.kt b/kdoc/src/main/kotlin/org/jetbrains/kotlin/doc/KDoc.kt index e450282390e..94295682d1c 100644 --- a/kdoc/src/main/kotlin/org/jetbrains/kotlin/doc/KDoc.kt +++ b/kdoc/src/main/kotlin/org/jetbrains/kotlin/doc/KDoc.kt @@ -1,8 +1,7 @@ package org.jetbrains.kotlin.doc -import std.template.* - import org.jetbrains.kotlin.doc.templates.* +import org.jetbrains.kotlin.template.TextTemplate import org.jetbrains.kotlin.model.KModel import java.io.File @@ -10,7 +9,27 @@ import java.io.File class KDocProcessor(val model: KModel, val outputDir: File) { fun execute(): Unit { + run("allclasses-frame.html", AllClassesFrameTemplate(model)) + run("allclasses-noframe.html", AllClassesFrameTemplate(model, " target=\"classFrame\"")) + // run("constant-values.html", ConstantValuesTemplate(model)) + // run("deprecated-list.html", DeprecatedListTemplate(model)) + run("help-doc.html", HelpDocTemplate(model)) + // run("index-all.html", IndexAllTemplate(model)) run("index.html", IndexTemplate(model)) + run("overview-frame.html", OverviewFrameTemplate(model)) + run("overview-summary.html", OverviewSummaryTemplate(model)) + run("overview-tree.html", OverviewTreeTemplate(model)) + run("package-list", PackageListTemplate(model)) + // run("serialized-form.html", SerializedFormTemplate(model)) + /** + TODO + */ + for (p in model.packages) { + run("${p.nameAsPath}/package-frame.html", PackageFrameTemplate(model, p)) + run("${p.nameAsPath}/package-summary.html", PackageSummaryTemplate(model, p)) + //run("${p.nameAsPath}/package-tree.html", PackageTreeTemplate(model, p)) + //run("${p.nameAsPath}/package-use.html", PackageUseTemplate(model, p)) + } } protected fun run(fileName: String, template: TextTemplate): Unit { diff --git a/kdoc/src/main/kotlin/org/jetbrains/kotlin/doc/templates/AllClassesFrameTemplate.kt b/kdoc/src/main/kotlin/org/jetbrains/kotlin/doc/templates/AllClassesFrameTemplate.kt new file mode 100644 index 00000000000..8fabdfe12b9 --- /dev/null +++ b/kdoc/src/main/kotlin/org/jetbrains/kotlin/doc/templates/AllClassesFrameTemplate.kt @@ -0,0 +1,47 @@ +package org.jetbrains.kotlin.doc.templates + +import std.* +import org.jetbrains.kotlin.template.* +import std.io.* +import std.util.* +import java.util.* +import org.jetbrains.kotlin.model.KModel + +class AllClassesFrameTemplate(val model: KModel, val classAttributes: String = "") : TextTemplate() { + override fun render() { + // TODO could really do with templates in multi-line strings :) + println(""" + + +""") + + println("") + println(""" +""") + println("All Classes (${model.title})") + print(""" + + + + + + + +All Classes +
+ + + + + +
""") + for (c in model.classes) { + println("${c.simpleName}") + println("
") + } + println("""
+ + +""") + } +} diff --git a/kdoc/src/main/kotlin/org/jetbrains/kotlin/doc/templates/HelpDocTemplate.kt b/kdoc/src/main/kotlin/org/jetbrains/kotlin/doc/templates/HelpDocTemplate.kt new file mode 100644 index 00000000000..fb25a68f6b0 --- /dev/null +++ b/kdoc/src/main/kotlin/org/jetbrains/kotlin/doc/templates/HelpDocTemplate.kt @@ -0,0 +1,237 @@ +package org.jetbrains.kotlin.doc.templates + +import std.* +import org.jetbrains.kotlin.template.* +import std.io.* +import std.util.* +import java.util.* +import org.jetbrains.kotlin.model.KModel + +class HelpDocTemplate(val model: KModel) : TextTemplate() { + override fun render() { + println(""" + + + + + +""") + println("API Help (${model.title})") + println(""" + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree  Deprecated  Index   Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+How This API Document Is Organized

+
+This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.

+Overview

+
+ +

+The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.

+

+Package

+
+ +

+Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain four categories:

+
+

+Class/Interface

+
+ +

+Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

+Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
+ +

+Annotation Type

+
+ +

+Each annotation type has its own separate page with the following sections:

+
+ +

+Enum

+
+ +

+Each enum has its own separate page with the following sections:

+
+

+Use

+
+Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.
+

+Tree (Class Hierarchy)

+
+There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object. +
+

+Deprecated API

+
+The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
+

+Index

+
+The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
+

+Prev/Next

+These links take you to the next or previous class, interface, package, or related page.

+Frames/No Frames

+These links show and hide the HTML frames. All pages are available with or without frames. +

+

+Serialized Form

+Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description. +

+

+Constant Field Values

+The Constant Field Values page lists the static final fields and their values. +

+ + +This help file applies to API documentation generated using the standard doclet. + +
+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree  Deprecated  Index   Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2012. All Rights Reserved. + +""") + } +} diff --git a/kdoc/src/main/kotlin/org/jetbrains/kotlin/doc/templates/IndexTemplate.kt b/kdoc/src/main/kotlin/org/jetbrains/kotlin/doc/templates/IndexTemplate.kt index f07e06c348e..cf509056dfe 100644 --- a/kdoc/src/main/kotlin/org/jetbrains/kotlin/doc/templates/IndexTemplate.kt +++ b/kdoc/src/main/kotlin/org/jetbrains/kotlin/doc/templates/IndexTemplate.kt @@ -1,7 +1,7 @@ package org.jetbrains.kotlin.doc.templates import std.* -import std.template.* +import org.jetbrains.kotlin.template.* import std.io.* import std.util.* import java.util.* @@ -10,47 +10,47 @@ import org.jetbrains.kotlin.model.KModel class IndexTemplate(val model: KModel) : TextTemplate() { override fun render() { print(""" - - - - - - +<!--NewPage--> +<HTML> +<HEAD> +<!-- Generated by javadoc on Mon Jan 09 13:32:00 EST 2012--> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<TITLE> """) print(model.title) - print(""") - - - - - - - - - - - - <H2> - Frame Alert</H2> + top.classFrame.location = top.targetPage; + } +</SCRIPT> +<NOSCRIPT> +</NOSCRIPT> +</HEAD> +<FRAMESET cols="20%,80%" title="" onLoad="top.loadFrames()"> +<FRAMESET rows="30%,70%" title="" onLoad="top.loadFrames()"> +<FRAME src="overview-frame.html" name="packageListFrame" title="All Packages"> +<FRAME src="allclasses-frame.html" name="packageFrame" title="All classes and interfaces (except non-static nested types)"> +</FRAMESET> +<FRAME src="overview-summary.html" name="classFrame" title="Package, class and interface descriptions" scrolling="yes"> +<NOFRAMES> +<H2> +Frame Alert</H2> - <P> - This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. - <BR> - Link to<A HREF="overview-summary.html">Non-frame version.</A> - - - - """) +

+This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. +
+Link toNon-frame version. + + + +""") } } diff --git a/kdoc/src/main/kotlin/org/jetbrains/kotlin/doc/templates/OverviewFrameTemplate.kt b/kdoc/src/main/kotlin/org/jetbrains/kotlin/doc/templates/OverviewFrameTemplate.kt new file mode 100644 index 00000000000..d19a342a12c --- /dev/null +++ b/kdoc/src/main/kotlin/org/jetbrains/kotlin/doc/templates/OverviewFrameTemplate.kt @@ -0,0 +1,57 @@ +package org.jetbrains.kotlin.doc.templates + +import std.* +import org.jetbrains.kotlin.template.* +import std.io.* +import std.util.* +import java.util.* +import org.jetbrains.kotlin.model.KModel + +class OverviewFrameTemplate(val model: KModel) : TextTemplate() { + override fun render() { + // TODO could really do with templates in multi-line strings :) + println(""" + + +""") + println("") + println(""" +""") + println("Overview List (${model.title})") + print(""" + + + + + + + + + + + +
+
+ + + + + +
All Classes +

+ +Packages +
""") + for (p in model.packages) { + println("${p.name}") + println("
") + } + println("""

+ +

+  + + +""") + } +} diff --git a/kdoc/src/main/kotlin/org/jetbrains/kotlin/doc/templates/OverviewSummaryTemplate.kt b/kdoc/src/main/kotlin/org/jetbrains/kotlin/doc/templates/OverviewSummaryTemplate.kt new file mode 100644 index 00000000000..043ac5ded40 --- /dev/null +++ b/kdoc/src/main/kotlin/org/jetbrains/kotlin/doc/templates/OverviewSummaryTemplate.kt @@ -0,0 +1,172 @@ +package org.jetbrains.kotlin.doc.templates + +import std.* +import org.jetbrains.kotlin.template.* +import std.io.* +import std.util.* +import java.util.* +import org.jetbrains.kotlin.model.KModel + +class OverviewSummaryTemplate(val model: KModel) : TextTemplate() { + override fun render() { + println(""" + + + + + +""") + println("Overview (${model.title})") + println(""" + + + + + + + + + + + +

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
 Overview  Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

""") + println(model.title) + println("""

+
+ + + + +""") + for (p in model.packages) { + println("") + println("") + println("") + println("") + } +println("""
+Packages
${p.nameAsPath}${p.description}
+ +

+ 

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
 Overview  Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2010-2012. All Rights Reserved. + +""") + } +} diff --git a/kdoc/src/main/kotlin/org/jetbrains/kotlin/doc/templates/OverviewTreeTemplate.kt b/kdoc/src/main/kotlin/org/jetbrains/kotlin/doc/templates/OverviewTreeTemplate.kt new file mode 100644 index 00000000000..84f79c40033 --- /dev/null +++ b/kdoc/src/main/kotlin/org/jetbrains/kotlin/doc/templates/OverviewTreeTemplate.kt @@ -0,0 +1,195 @@ +package org.jetbrains.kotlin.doc.templates + +import std.* +import org.jetbrains.kotlin.template.* +import std.io.* +import std.util.* +import java.util.* +import org.jetbrains.kotlin.model.KModel + +class OverviewTreeTemplate(val model: KModel) : TextTemplate() { + override fun render() { + println(""" + + + + + +""") + println("Class Hierarchy (${model.title})") + println(""" + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For All Packages

+
+
+
Package Hierarchies:
""") + + var first = true + for (p in model.packages) { + if (first) { + first = false + } else { + print(", ") + print("${p.nameAsPath}") + } + } + println("""
+
+

+Class Hierarchy +

""") + + // TODO walk the hierarchy... + /* +