Skip to content

Commit ab63162

Browse files
committed
docs: Add missing docs and separate inherited members
1 parent 15eaed8 commit ab63162

3 files changed

Lines changed: 4 additions & 0 deletions

File tree

buildSrc/src/main/kotlin/commons.gradle.kts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ repositories {
4444

4545
tasks.withType<DokkaTaskPartial>().configureEach {
4646
dokkaSourceSets.configureEach {
47+
reportUndocumented.set(true)
4748
sourceLink {
4849
localDirectory.set(file("src/main/kotlin/"))
4950
remoteUrl.set(URL("https://github.com/EndlessCodeGroup/Mimic/tree/develop/${project.name}/src/main/kotlin/"))
@@ -52,6 +53,7 @@ tasks.withType<DokkaTaskPartial>().configureEach {
5253
url.set(URL("https://hub.spigotmc.org/javadocs/spigot/"))
5354
packageListUrl.set(URL("https://gist.githubusercontent.com/osipxd/604c9b3f91c3a6c56050f4a3b027f333/raw/package-list"))
5455
}
56+
pluginsMapConfiguration.put("org.jetbrains.dokka.base.DokkaBase", """{ "separateInheritedMembers": true}""")
5557
}
5658
}
5759

mimic-bukkit-api/src/main/kotlin/classes/BukkitClassSystem.kt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ import ru.endlesscode.mimic.util.ExistingWeakReference
2626
/** [ClassSystem] for Bukkit. */
2727
public abstract class BukkitClassSystem(player: Player) : ClassSystem {
2828

29+
/** Player owning this class system. */
2930
public val player: Player get() = playerRef.get()
3031

3132
private val playerRef: ExistingWeakReference<Player> = ExistingWeakReference(player)

mimic-bukkit-api/src/main/kotlin/level/BukkitLevelSystem.kt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ import ru.endlesscode.mimic.util.ExistingWeakReference
2626
/** [LevelSystem] for Bukkit. */
2727
public abstract class BukkitLevelSystem(player: Player) : LevelSystem {
2828

29+
/** Player owning this level system. */
2930
public val player: Player get() = playerRef.get()
3031

3132
private val playerRef: ExistingWeakReference<Player> = ExistingWeakReference(player)

0 commit comments

Comments
 (0)