Skip to content

Commit

Permalink
Update pillarbox-player module documentation (#792)
Browse files Browse the repository at this point in the history
  • Loading branch information
MGaetan89 authored Nov 20, 2024
1 parent 3f6e6e1 commit 7ede973
Show file tree
Hide file tree
Showing 7 changed files with 132 additions and 112 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -89,11 +89,7 @@ class PillarboxAndroidLibraryPublishingPlugin : Plugin<Project> {

extensions.configure<DokkaExtension> {
dokkaSourceSets.getByName("main") {
if (file("Module.md").exists()) {
includes.from("Module.md")
} else {
includes.from("docs/README.md")
}
includes.from("docs/README.md")

externalDocumentationLinks.register("kotlinx.coroutines") {
url.set(URI("https://kotlinlang.org/api/kotlinx.coroutines"))
Expand Down
2 changes: 1 addition & 1 deletion pillarbox-analytics/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ and custom events.

## Integration

To use this module, add the following dependency to your project's `build.gradle`/`build.gradle.kts` file:
To use this module, add the following dependency to your module's `build.gradle`/`build.gradle.kts` file:

```kotlin
implementation("ch.srgssr.pillarbox:pillarbox-analytics:<pillarbox_version>")
Expand Down
2 changes: 1 addition & 1 deletion pillarbox-cast/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Provides helpers to integrate Cast with Pillarbox.

## Integration

To use this module, add the following dependency to your project's `build.gradle`/`build.gradle.kts` file:
To use this module, add the following dependency to your module's `build.gradle`/`build.gradle.kts` file:

```kotlin
implementation("ch.srgssr.pillarbox:pillarbox-cast:<pillarbox_version>")
Expand Down
2 changes: 1 addition & 1 deletion pillarbox-core-business/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The supported contents are:

## Integration

To use this module, add the following dependency to your project's `build.gradle`/`build.gradle.kts` file:
To use this module, add the following dependency to your module's `build.gradle`/`build.gradle.kts` file:

```kotlin
implementation("ch.srgssr.pillarbox:pillarbox-core-business:<pillarbox_version>")
Expand Down
10 changes: 0 additions & 10 deletions pillarbox-player/Module.md

This file was deleted.

Loading

0 comments on commit 7ede973

Please sign in to comment.