Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Configure Dokka tasks for project & modules #11

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+57 −0
Open

Configure Dokka tasks for project & modules #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import org.jetbrains.dokka.gradle.DokkaMultiModuleTask

plugins {
kotlin("jvm") version "2.0.20"

Expand All @@ -7,6 +9,17 @@ plugins {
id("org.jetbrains.kotlin.android") version "2.0.20" apply false
}

tasks.withType<DokkaMultiModuleTask>().configureEach {
val dokkaDir = layout.buildDirectory.dir("dokka")
outputDirectory.set(dokkaDir)
pluginsMapConfiguration.set(
mapOf(Pair("org.jetbrains.dokka.base.DokkaBase", """
{
"footerMessage": "Copyright © 2024 Expressway contributors, BSD-3-Clause"
}"""))
)
}

repositories {
mavenCentral()
gradlePluginPortal()
Expand Down
11 changes: 11 additions & 0 deletions core/MODULE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Module core

Base functionality that is not dependent on the FIRST Tech Challenge SDK

# Package page.j5155.expressway.core.actions

RoadRunner Action expanded functionality

# Package page.j5155.expressway.core.geometry

Geometrical functionality
10 changes: 10 additions & 0 deletions core/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import org.jetbrains.dokka.gradle.DokkaTaskPartial
import java.io.ByteArrayOutputStream

/* Gets the version name from the latest Git tag */
Expand Down Expand Up @@ -37,6 +38,15 @@ dependencies {
tasks.test {
useJUnitPlatform()
}

tasks.withType<DokkaTaskPartial>().configureEach {
dokkaSourceSets {
configureEach {
includes.from("MODULE.md")
}
}
}

kotlin {
jvmToolchain(18)
}
Expand Down
15 changes: 15 additions & 0 deletions ftc/MODULE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Module ftc

Expressway functionality dependent on the FIRST Tech Challenge SDK

# Package page.j5155.expressway.ftc.actions

Additional functionality for RoadRunner Actions

# Package page.j5155.expressway.ftc.geometry

Expanded Geometry functionality

# Package page.j5155.expressway.ftc.motion

Motion control systems
8 changes: 8 additions & 0 deletions ftc/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import org.jetbrains.dokka.gradle.DokkaTaskPartial
import java.io.ByteArrayOutputStream

/* Gets the version name from the latest Git tag */
Expand Down Expand Up @@ -39,6 +40,13 @@ dependencies {
implementation("com.acmerobotics.roadrunner:actions:1.0.0")
}

tasks.withType<DokkaTaskPartial>().configureEach {
dokkaSourceSets {
configureEach {
includes.from("MODULE.md")
}
}
}

android {
namespace = "page.j5155.roadrunner.expressway.ftc"
Expand Down