buildSrc/src/main/kotlin/Dokka.kt
author Da Risk <da_risk@geekorum.com>
Mon, 26 May 2025 18:27:07 -0400
changeset 107 627dd879e3a4
parent 84 f1e51fe391c2
permissions -rw-r--r--
material3: add uiTooling dependencies commented as it increase build size
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
73
1b1779baa28f build: configure dokka conventions
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     1
/*
1b1779baa28f build: configure dokka conventions
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     2
 * AboutOss is a utility library to retrieve and display
1b1779baa28f build: configure dokka conventions
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     3
 * opensource licenses in Android applications.
1b1779baa28f build: configure dokka conventions
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     4
 *
1b1779baa28f build: configure dokka conventions
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     5
 * Copyright (C) 2023-2025 by Frederic-Charles Barthelery.
1b1779baa28f build: configure dokka conventions
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     6
 *
1b1779baa28f build: configure dokka conventions
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     7
 * This file is part of AboutOss.
1b1779baa28f build: configure dokka conventions
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     8
 *
1b1779baa28f build: configure dokka conventions
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     9
 * AboutOss is free software: you can redistribute it and/or modify
1b1779baa28f build: configure dokka conventions
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    10
 * it under the terms of the GNU General Public License as published by
1b1779baa28f build: configure dokka conventions
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    11
 * the Free Software Foundation, either version 3 of the License, or
1b1779baa28f build: configure dokka conventions
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    12
 * (at your option) any later version.
1b1779baa28f build: configure dokka conventions
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    13
 *
1b1779baa28f build: configure dokka conventions
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    14
 * AboutOss is distributed in the hope that it will be useful,
1b1779baa28f build: configure dokka conventions
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    15
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
1b1779baa28f build: configure dokka conventions
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    16
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
1b1779baa28f build: configure dokka conventions
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    17
 * GNU General Public License for more details.
1b1779baa28f build: configure dokka conventions
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    18
 *
1b1779baa28f build: configure dokka conventions
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    19
 * You should have received a copy of the GNU General Public License
1b1779baa28f build: configure dokka conventions
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    20
 * along with AboutOss.  If not, see <http://www.gnu.org/licenses/>.
1b1779baa28f build: configure dokka conventions
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    21
 */
1b1779baa28f build: configure dokka conventions
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    22
package com.geekorum.build
1b1779baa28f build: configure dokka conventions
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    23
1b1779baa28f build: configure dokka conventions
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    24
import org.gradle.api.Project
1b1779baa28f build: configure dokka conventions
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    25
import org.gradle.kotlin.dsl.apply
1b1779baa28f build: configure dokka conventions
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    26
import org.gradle.kotlin.dsl.assign
1b1779baa28f build: configure dokka conventions
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    27
import org.gradle.kotlin.dsl.configure
1b1779baa28f build: configure dokka conventions
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    28
import org.jetbrains.dokka.gradle.DokkaExtension
1b1779baa28f build: configure dokka conventions
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    29
import org.jetbrains.dokka.gradle.DokkaPlugin
1b1779baa28f build: configure dokka conventions
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    30
1b1779baa28f build: configure dokka conventions
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    31
1b1779baa28f build: configure dokka conventions
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    32
internal fun Project.configureDokka() {
1b1779baa28f build: configure dokka conventions
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    33
    apply<DokkaPlugin>()
1b1779baa28f build: configure dokka conventions
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    34
1b1779baa28f build: configure dokka conventions
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    35
    configure<DokkaExtension> {
1b1779baa28f build: configure dokka conventions
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    36
        dokkaSourceSets.configureEach {
1b1779baa28f build: configure dokka conventions
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    37
            reportUndocumented = true
1b1779baa28f build: configure dokka conventions
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    38
            sourceLink {
1b1779baa28f build: configure dokka conventions
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    39
                localDirectory = rootDir
1b1779baa28f build: configure dokka conventions
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    40
                remoteUrl = uri("https://github.com/fbarthelery/AboutOss/tree/main/")
1b1779baa28f build: configure dokka conventions
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    41
            }
84
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents: 73
diff changeset
    42
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents: 73
diff changeset
    43
            externalDocumentationLinks.register("okio") {
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents: 73
diff changeset
    44
                url = uri("https://square.github.io/okio/3.x/okio/okio/")
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents: 73
diff changeset
    45
            }
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents: 73
diff changeset
    46
            externalDocumentationLinks.register("kotlinx-coroutines") {
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents: 73
diff changeset
    47
                url = uri("https://kotlinlang.org/api/kotlinx.coroutines/")
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents: 73
diff changeset
    48
            }
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents: 73
diff changeset
    49
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents: 73
diff changeset
    50
            perPackageOption {
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents: 73
diff changeset
    51
                matchingRegex = ".*\\.generated\\.resources"
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents: 73
diff changeset
    52
                suppress = true
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents: 73
diff changeset
    53
            }
73
1b1779baa28f build: configure dokka conventions
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    54
        }
1b1779baa28f build: configure dokka conventions
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    55
    }
1b1779baa28f build: configure dokka conventions
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    56
1b1779baa28f build: configure dokka conventions
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    57
}