mirrors/Unciv
1
0
Fork 0
mirror of https://github.com/yairm210/Unciv.git synced 2025-07-06 08:21:36 +07:00
Code Issues Packages Projects Releases Wiki Activity

Better autogenerated unique docs

Browse Source
This commit is contained in:
yairm210
2021-11-22 21:10:21 +02:00
parent 4113b810ff
commit 92fd72d895
2 changed files with 190 additions and 238 deletions
Download Patch File Download Diff File Expand all files Collapse all files

47
desktop/src/com/unciv/app/desktop/UniqueDocsWriter.kt
View File

@ -1,19 +1,56 @@
package com.unciv.app.desktop
import com.unciv.models.ruleset.Ruleset
import com.unciv.models.ruleset.unique.UniqueType
import java.io.File
class UniqueDocsWriter {
fun toLink(string: String): String {
return "#" + string.split(' ').map { it.lowercase() }.joinToString("-")
}
fun write() {
val lines = ArrayList<String>()
for (targetType in UniqueType.values().groupBy { it.targetTypes.first() }) {
val targetTypesToUniques = UniqueType.values().groupBy { it.targetTypes.first() }
lines += "## Table of Contents\n"
for (targetType in targetTypesToUniques) {
val sectionName = targetType.key.name + " uniques"
lines += " - [$sectionName](${toLink(sectionName)})"
}
lines += " - [Deprecated uniques](#deprecated-uniques)"
lines += ""
val deprecatedUniques = ArrayList<UniqueType>()
for (targetType in targetTypesToUniques) {
lines += "## " + targetType.key.name + " uniques"
for (unique in targetType.value) {
lines += "#### " + unique.text
lines += "Applicable to: " + unique.targetTypes.joinToString()
for (uniqueType in targetType.value) {
val deprecationAnnotation = uniqueType.declaringClass.getField(uniqueType.name)
.getAnnotation(Deprecated::class.java)
if (deprecationAnnotation != null){
deprecatedUniques += uniqueType
continue
}
lines += "#### " + uniqueType.text
lines += "Applicable to: " + uniqueType.targetTypes.joinToString()
lines += ""
}
}
lines += "## Deprecated uniques"
for (deprecatedUnique in deprecatedUniques) {
val deprecationAnnotation =
deprecatedUnique.declaringClass.getField(deprecatedUnique.name)
.getAnnotation(Deprecated::class.java)
val deprecationText = "Deprecated ${deprecationAnnotation.message}," +
if (deprecationAnnotation.replaceWith.expression != "") " replace with \"${deprecationAnnotation.replaceWith.expression}\"" else ""
lines += " - \"${deprecatedUnique.text}\" - $deprecationText"
}
File("../../docs/uniques.md").writeText(lines.joinToString("\n"))
}
}
}