aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKamil Doległo <kamilok1965@interia.pl>2019-05-15 12:13:13 +0200
committerKamil Doległo <kamilok1965@interia.pl>2019-05-15 12:13:13 +0200
commitfd6c34d92b7409d3aedd9416c7b06f9c48fe2631 (patch)
tree4b1422c184ec578c8d9103bdba3e38fa756d984f
parentc605d0c2b75cce9ad8b818cfd75b49c684e2eb98 (diff)
downloaddokka-fd6c34d92b7409d3aedd9416c7b06f9c48fe2631.tar.gz
dokka-fd6c34d92b7409d3aedd9416c7b06f9c48fe2631.tar.bz2
dokka-fd6c34d92b7409d3aedd9416c7b06f9c48fe2631.zip
Fix SinceKotlin
-rw-r--r--core/src/main/kotlin/Formats/StructuredFormatService.kt22
-rw-r--r--core/src/test/kotlin/DokkaConfigurationTestImplementations.kt2
-rw-r--r--core/testdata/format/sinceKotlin.html2
-rw-r--r--core/testdata/format/sinceKotlin.md2
-rw-r--r--core/testdata/format/sinceKotlin.package.md6
-rw-r--r--core/testdata/format/sinceKotlinWide.package.md4
-rw-r--r--integration/src/main/kotlin/org/jetbrains/dokka/configuration.kt2
-rw-r--r--integration/src/main/kotlin/org/jetbrains/dokka/defaultConfiguration.kt2
-rw-r--r--runners/ant/src/main/kotlin/ant/dokka.kt2
-rw-r--r--runners/cli/src/main/kotlin/cli/main.kt4
-rw-r--r--runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/configurationImplementations.kt2
-rw-r--r--runners/maven-plugin/src/main/kotlin/DokkaMojo.kt2
12 files changed, 26 insertions, 26 deletions
diff --git a/core/src/main/kotlin/Formats/StructuredFormatService.kt b/core/src/main/kotlin/Formats/StructuredFormatService.kt
index a6c1b57f..e088b46d 100644
--- a/core/src/main/kotlin/Formats/StructuredFormatService.kt
+++ b/core/src/main/kotlin/Formats/StructuredFormatService.kt
@@ -110,10 +110,8 @@ abstract class StructuredOutputBuilder(val to: StringBuilder,
abstract fun appendText(text: String)
open fun appendSinceKotlin(version: String) {
- appendParagraph {
appendText("Since: ")
appendCode { appendText(version) }
- }
}
open fun appendSectionWithTag(section: ContentSection) {
@@ -279,9 +277,7 @@ abstract class StructuredOutputBuilder(val to: StringBuilder,
}
protected open fun appendPlatformsAsText(platforms: PlatformsData) {
- if (platforms.isNotEmpty()) {
- appendText(platforms.keys.joinToString(prefix = "(", postfix = ") "))
- }
+ appendPlatforms(platforms)
}
protected open fun appendPlatforms(platforms: PlatformsData) {
@@ -757,15 +753,14 @@ abstract class StructuredOutputBuilder(val to: StringBuilder,
appendTable("Name", "Summary") {
appendTableBody {
- for ((memberLocation, members) in membersMap) {
- val platforms = effectivePlatformsForMembers(members)
+ for ((memberLocation, membersList) in membersMap) {
+ val platforms = effectivePlatformsForMembers(membersList)
// val platforms = if (platformsBasedOnMembers)
// members.flatMapTo(mutableSetOf()) { platformsOfItems(it.members) } + elementPlatforms
// else
// elementPlatforms
- val summarized = computeSummarySignatures(members)
-
+ val summarized = computeSummarySignatures(membersList)
appendIndexRow(platforms) {
appendTableCell {
@@ -774,8 +769,15 @@ abstract class StructuredOutputBuilder(val to: StringBuilder,
}
// appendHeader(level = 4) {
// appendParagraph {
- appendLink(memberLocation)
+ appendLink(memberLocation)
+
+ if (node.sinceKotlin != null) {
+ appendSinceKotlin(node.sinceKotlin.toString())
+ }
+ if (membersList.singleOrNull()?.sinceKotlin != null){
+ wrap(" (", ")"){ appendSinceKotlin(membersList.single().sinceKotlin.toString()) }
+ }
// }
// if (members.singleOrNull()?.kind != NodeKind.ExternalClass) {
// appendPlatforms(platforms)
diff --git a/core/src/test/kotlin/DokkaConfigurationTestImplementations.kt b/core/src/test/kotlin/DokkaConfigurationTestImplementations.kt
index 19ec1e64..a6f427b1 100644
--- a/core/src/test/kotlin/DokkaConfigurationTestImplementations.kt
+++ b/core/src/test/kotlin/DokkaConfigurationTestImplementations.kt
@@ -65,7 +65,7 @@ class PassConfigurationImpl (
override val collectInheritedExtensionsFromLibraries: Boolean = false,
override val analysisPlatform: Platform = Platform.DEFAULT,
override val targets: List<String> = emptyList(),
- override val sinceKotlin: String = "1.0"
+ override val sinceKotlin: String? = null
): DokkaConfiguration.PassConfiguration {
private val defaultLinks = run {
val links = mutableListOf<DokkaConfiguration.ExternalDocumentationLink>()
diff --git a/core/testdata/format/sinceKotlin.html b/core/testdata/format/sinceKotlin.html
index 12cdd87f..1173a8ab 100644
--- a/core/testdata/format/sinceKotlin.html
+++ b/core/testdata/format/sinceKotlin.html
@@ -14,7 +14,7 @@
<tbody>
<tr>
<td>
-<a href="-init-.html">&lt;init&gt;</a></td>
+<a href="-init-.html">&lt;init&gt;</a>Since: <code>1.1</code></td>
<td>
<code><span class="identifier">Since1.1</span><span class="symbol">(</span><span class="symbol">)</span></code>
<p>Useful</p>
diff --git a/core/testdata/format/sinceKotlin.md b/core/testdata/format/sinceKotlin.md
index 188784d6..e9b29229 100644
--- a/core/testdata/format/sinceKotlin.md
+++ b/core/testdata/format/sinceKotlin.md
@@ -8,5 +8,5 @@ Useful
### Constructors
-| [&lt;init&gt;](-init-.md) | `Since1.1()`<br>Useful |
+| [&lt;init&gt;](-init-.md)Since: `1.1` | `Since1.1()`<br>Useful |
diff --git a/core/testdata/format/sinceKotlin.package.md b/core/testdata/format/sinceKotlin.package.md
index eabf88d5..92197648 100644
--- a/core/testdata/format/sinceKotlin.package.md
+++ b/core/testdata/format/sinceKotlin.package.md
@@ -1,10 +1,8 @@
-[test](./index.md)
+[test](../index.md)
## Package &lt;root&gt;
-**Platform and version requirements:** Kotlin 1.1
-
### Types
-| [Since1.1](-since1.1/index.md)<br>(Kotlin 1.1) | `class Since1.1`<br>Useful |
+| [Since1.1](-since1.1/index.md) (Since: `1.1`) | `class Since1.1`<br>Useful |
diff --git a/core/testdata/format/sinceKotlinWide.package.md b/core/testdata/format/sinceKotlinWide.package.md
index d2c2b6d8..fd7d45aa 100644
--- a/core/testdata/format/sinceKotlinWide.package.md
+++ b/core/testdata/format/sinceKotlinWide.package.md
@@ -4,6 +4,6 @@
### Types
-| [Since1.1](-since1.1/index.md)<br>(Kotlin 1.1) | `class Since1.1`<br>Useful |
-| [Since1.2](-since1.2/index.md)<br>(Kotlin 1.2) | `class Since1.2`<br>Useful also |
+| [Since1.1](-since1.1/index.md) (Since: `1.1`) | `class Since1.1`<br>Useful |
+| [Since1.2](-since1.2/index.md) (Since: `1.2`) | `class Since1.2`<br>Useful also |
diff --git a/integration/src/main/kotlin/org/jetbrains/dokka/configuration.kt b/integration/src/main/kotlin/org/jetbrains/dokka/configuration.kt
index 7c6753d4..b41479cf 100644
--- a/integration/src/main/kotlin/org/jetbrains/dokka/configuration.kt
+++ b/integration/src/main/kotlin/org/jetbrains/dokka/configuration.kt
@@ -56,7 +56,7 @@ interface DokkaConfiguration {
val collectInheritedExtensionsFromLibraries: Boolean
val analysisPlatform: Platform
val targets: List<String>
- val sinceKotlin: String
+ val sinceKotlin: String?
}
interface SourceRoot {
diff --git a/integration/src/main/kotlin/org/jetbrains/dokka/defaultConfiguration.kt b/integration/src/main/kotlin/org/jetbrains/dokka/defaultConfiguration.kt
index 6d754ebc..78112904 100644
--- a/integration/src/main/kotlin/org/jetbrains/dokka/defaultConfiguration.kt
+++ b/integration/src/main/kotlin/org/jetbrains/dokka/defaultConfiguration.kt
@@ -35,7 +35,7 @@ data class PassConfigurationImpl (
override val collectInheritedExtensionsFromLibraries: Boolean,
override val analysisPlatform: Platform,
override val targets: List<String>,
- override val sinceKotlin: String
+ override val sinceKotlin: String?
) : DokkaConfiguration.PassConfiguration
diff --git a/runners/ant/src/main/kotlin/ant/dokka.kt b/runners/ant/src/main/kotlin/ant/dokka.kt
index a54d1351..3ecc7b94 100644
--- a/runners/ant/src/main/kotlin/ant/dokka.kt
+++ b/runners/ant/src/main/kotlin/ant/dokka.kt
@@ -64,7 +64,7 @@ class AntPassConfig(task: Task) : DokkaConfiguration.PassConfiguration {
get() = buildTargets.filter { it.value != "" }
.map { it.value }
- override var sinceKotlin: String = "1.0"
+ override var sinceKotlin: String? = null
private val samplesPath: Path by lazy { Path(task.project) }
private val includesPath: Path by lazy { Path(task.project) }
diff --git a/runners/cli/src/main/kotlin/cli/main.kt b/runners/cli/src/main/kotlin/cli/main.kt
index 9e42d01a..63b586f2 100644
--- a/runners/cli/src/main/kotlin/cli/main.kt
+++ b/runners/cli/src/main/kotlin/cli/main.kt
@@ -117,10 +117,10 @@ class Arguments(val parser: DokkaArgumentsParser) : DokkaConfiguration.PassConfi
""
)
- override val sinceKotlin: String by parser.stringOption(
+ override val sinceKotlin: String? by parser.stringOption(
listOf("-sinceKotlin"),
"Kotlin Api version to use as base version, if none specified",
- "1.0"
+ null
)
override val collectInheritedExtensionsFromLibraries: Boolean by parser.singleFlag(
diff --git a/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/configurationImplementations.kt b/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/configurationImplementations.kt
index fd889d78..85671c5b 100644
--- a/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/configurationImplementations.kt
+++ b/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/configurationImplementations.kt
@@ -43,7 +43,7 @@ open class GradlePassConfigurationImpl(@Transient val name: String = ""): PassCo
override var analysisPlatform: Platform = Platform.DEFAULT
var platform: String = ""
override var targets: List<String> = emptyList()
- override var sinceKotlin: String = "1.0"
+ override var sinceKotlin: String? = null
fun sourceRoot(c: Closure<Unit>) {
val configured = ConfigureUtil.configure(c, GradleSourceRootImpl())
diff --git a/runners/maven-plugin/src/main/kotlin/DokkaMojo.kt b/runners/maven-plugin/src/main/kotlin/DokkaMojo.kt
index 650f268f..4dcc49ba 100644
--- a/runners/maven-plugin/src/main/kotlin/DokkaMojo.kt
+++ b/runners/maven-plugin/src/main/kotlin/DokkaMojo.kt
@@ -126,7 +126,7 @@ abstract class AbstractDokkaMojo : AbstractMojo() {
var targets: List<String> = emptyList()
@Parameter
- var sinceKotlin: String = "1.0"
+ var sinceKotlin: String? = null
@Parameter
var includeNonPublic: Boolean = false