buildSrc/src/main/kotlin/Dokka.kt
changeset 73 1b1779baa28f
child 84 f1e51fe391c2
equal deleted inserted replaced
72:746669e015f9 73:1b1779baa28f
       
     1 /*
       
     2  * AboutOss is a utility library to retrieve and display
       
     3  * opensource licenses in Android applications.
       
     4  *
       
     5  * Copyright (C) 2023-2025 by Frederic-Charles Barthelery.
       
     6  *
       
     7  * This file is part of AboutOss.
       
     8  *
       
     9  * AboutOss is free software: you can redistribute it and/or modify
       
    10  * it under the terms of the GNU General Public License as published by
       
    11  * the Free Software Foundation, either version 3 of the License, or
       
    12  * (at your option) any later version.
       
    13  *
       
    14  * AboutOss is distributed in the hope that it will be useful,
       
    15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
       
    16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
       
    17  * GNU General Public License for more details.
       
    18  *
       
    19  * You should have received a copy of the GNU General Public License
       
    20  * along with AboutOss.  If not, see <http://www.gnu.org/licenses/>.
       
    21  */
       
    22 package com.geekorum.build
       
    23 
       
    24 import org.gradle.api.Project
       
    25 import org.gradle.kotlin.dsl.apply
       
    26 import org.gradle.kotlin.dsl.assign
       
    27 import org.gradle.kotlin.dsl.configure
       
    28 import org.jetbrains.dokka.gradle.DokkaExtension
       
    29 import org.jetbrains.dokka.gradle.DokkaPlugin
       
    30 
       
    31 
       
    32 internal fun Project.configureDokka() {
       
    33     apply<DokkaPlugin>()
       
    34 
       
    35     configure<DokkaExtension> {
       
    36         dokkaSourceSets.configureEach {
       
    37             reportUndocumented = true
       
    38             sourceLink {
       
    39                 localDirectory = rootDir
       
    40                 remoteUrl = uri("https://github.com/fbarthelery/AboutOss/tree/main/")
       
    41             }
       
    42         }
       
    43     }
       
    44 
       
    45 }