From 6662e20f43de81add9f5d8ff813535fcadb1db9b Mon Sep 17 00:00:00 2001 From: Benoit Marty Date: Mon, 12 Dec 2022 14:19:04 +0100 Subject: [PATCH] Add some documentation. --- docs/usefulLinks.md | 2 ++ gradle/libs.versions.toml | 3 +++ .../java/io.element.android-compose-application.gradle.kts | 3 +++ .../main/java/io.element.android-compose-library.gradle.kts | 3 +++ plugins/src/main/java/io.element.android-library.gradle.kts | 3 +++ 5 files changed, 14 insertions(+) diff --git a/docs/usefulLinks.md b/docs/usefulLinks.md index 2238488586..5091277977 100644 --- a/docs/usefulLinks.md +++ b/docs/usefulLinks.md @@ -7,6 +7,8 @@ ### VersionCatalog +https://docs.gradle.org/current/userguide/platforms.html + ### Jetpack Compose https://developer.android.com/jetpack/compose/mental-model diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml index 94066aefea..6fd67b5022 100644 --- a/gradle/libs.versions.toml +++ b/gradle/libs.versions.toml @@ -1,3 +1,6 @@ +# This file is referenced in ./plugins/settings.gradle.kts to generate the version catalog. +# https://docs.gradle.org/current/userguide/platforms.html#sub::toml-dependencies-format + [versions] # Project android_gradle_plugin = "7.3.1" diff --git a/plugins/src/main/java/io.element.android-compose-application.gradle.kts b/plugins/src/main/java/io.element.android-compose-application.gradle.kts index 3cc8808cf3..807ac5245d 100644 --- a/plugins/src/main/java/io.element.android-compose-application.gradle.kts +++ b/plugins/src/main/java/io.element.android-compose-application.gradle.kts @@ -1,3 +1,6 @@ +/** + * This will generate the plugin "io.element.android-compose-application", used only in the module `app`. + */ import extension.androidConfig import extension.commonDependencies import extension.composeConfig diff --git a/plugins/src/main/java/io.element.android-compose-library.gradle.kts b/plugins/src/main/java/io.element.android-compose-library.gradle.kts index 1a1603f1d7..fdb73e897e 100644 --- a/plugins/src/main/java/io.element.android-compose-library.gradle.kts +++ b/plugins/src/main/java/io.element.android-compose-library.gradle.kts @@ -1,3 +1,6 @@ +/** + * This will generate the plugin "io.element.android-compose-library", used in android library with compose modules. + */ import extension.androidConfig import extension.commonDependencies import extension.composeConfig diff --git a/plugins/src/main/java/io.element.android-library.gradle.kts b/plugins/src/main/java/io.element.android-library.gradle.kts index 37185e5024..ed74db1f96 100644 --- a/plugins/src/main/java/io.element.android-library.gradle.kts +++ b/plugins/src/main/java/io.element.android-library.gradle.kts @@ -1,3 +1,6 @@ +/** + * This will generate the plugin "io.element.android-library", used in android library without compose modules. + */ import extension.androidConfig import extension.commonDependencies