From 2df5c9886f7f3f167870e7aa389b857c9dd2d165 Mon Sep 17 00:00:00 2001 From: James Strachan Date: Fri, 13 Apr 2012 15:43:44 +0100 Subject: [PATCH] include a target and css style for external source links in the doc --- .../main/kotlin/org/jetbrains/kotlin/doc/model/KotlinModel.kt | 4 ++++ .../jetbrains/kotlin/doc/templates/ClassExtensionsTemplate.kt | 2 +- .../org/jetbrains/kotlin/doc/templates/ClassTemplate.kt | 2 +- .../jetbrains/kotlin/doc/templates/PackageTemplateSupport.kt | 4 ++-- 4 files changed, 8 insertions(+), 4 deletions(-) diff --git a/libraries/tools/kdoc/src/main/kotlin/org/jetbrains/kotlin/doc/model/KotlinModel.kt b/libraries/tools/kdoc/src/main/kotlin/org/jetbrains/kotlin/doc/model/KotlinModel.kt index 85be8b91aa2..69390a01843 100644 --- a/libraries/tools/kdoc/src/main/kotlin/org/jetbrains/kotlin/doc/model/KotlinModel.kt +++ b/libraries/tools/kdoc/src/main/kotlin/org/jetbrains/kotlin/doc/model/KotlinModel.kt @@ -761,6 +761,10 @@ abstract class KAnnotated(val model: KModel, val declarationDescriptor: Declarat return model.config.sourceRootHref != null } + fun sourceTargetAttribute(): String { + return if (isLinkToSourceRepo()) " target=\"_top\" class=\"repoSourceCode\"" else "" + } + fun sourceLink(): String { val file = model.filePath(declarationDescriptor) if (file != null) { diff --git a/libraries/tools/kdoc/src/main/kotlin/org/jetbrains/kotlin/doc/templates/ClassExtensionsTemplate.kt b/libraries/tools/kdoc/src/main/kotlin/org/jetbrains/kotlin/doc/templates/ClassExtensionsTemplate.kt index 507985d9d6f..f43aabefdab 100644 --- a/libraries/tools/kdoc/src/main/kotlin/org/jetbrains/kotlin/doc/templates/ClassExtensionsTemplate.kt +++ b/libraries/tools/kdoc/src/main/kotlin/org/jetbrains/kotlin/doc/templates/ClassExtensionsTemplate.kt @@ -29,7 +29,7 @@ ${pkg.name} Extensions on ${klass.name}
-extension functions on class ${klass.name}
+extension functions on class ${klass.name}
from package ${link(pkg)}
diff --git a/libraries/tools/kdoc/src/main/kotlin/org/jetbrains/kotlin/doc/templates/ClassTemplate.kt b/libraries/tools/kdoc/src/main/kotlin/org/jetbrains/kotlin/doc/templates/ClassTemplate.kt index fa990cc07b0..8c25a676bcb 100644 --- a/libraries/tools/kdoc/src/main/kotlin/org/jetbrains/kotlin/doc/templates/ClassTemplate.kt +++ b/libraries/tools/kdoc/src/main/kotlin/org/jetbrains/kotlin/doc/templates/ClassTemplate.kt @@ -184,7 +184,7 @@ Class ${klass.simpleName}
""")
         printAnnotations(klass.annotations)
-        print("""${klass.visibility} ${klass.kindCode} ${klass.simpleName}
""") + print("""${klass.visibility} ${klass.kindCode} ${klass.simpleName}
""") if (!klass.baseClasses.isEmpty()) { print("""extends """) for (bc in klass.baseClasses) { diff --git a/libraries/tools/kdoc/src/main/kotlin/org/jetbrains/kotlin/doc/templates/PackageTemplateSupport.kt b/libraries/tools/kdoc/src/main/kotlin/org/jetbrains/kotlin/doc/templates/PackageTemplateSupport.kt index b6fb43cf8c3..05cabceea97 100644 --- a/libraries/tools/kdoc/src/main/kotlin/org/jetbrains/kotlin/doc/templates/PackageTemplateSupport.kt +++ b/libraries/tools/kdoc/src/main/kotlin/org/jetbrains/kotlin/doc/templates/PackageTemplateSupport.kt @@ -128,7 +128,7 @@ abstract class PackageTemplateSupport(open val pkg: KPackage) : KDocTemplate() { printTypeParameters(function, " ") printReceiverType(function, " ", ".", " ") - print("""${function.name}""") + print("""${function.name}""") printParameters(function) print(": ") print(link(function.returnType)) @@ -207,7 +207,7 @@ abstract class PackageTemplateSupport(open val pkg: KPackage) : KDocTemplate() { } */ println("""""") - print("""${property.name}: """) + print("""${property.name}: """) print(link(property.returnType)) //printParameters(property) println("""""")