From 8e5c63d035ef44a269b8c43430f43f5c8eebfb63 Mon Sep 17 00:00:00 2001 From: Ignat Beresnev Date: Fri, 10 Nov 2023 11:46:54 +0100 Subject: Restructure the project to utilize included builds (#3174) * Refactor and simplify artifact publishing * Update Gradle to 8.4 * Refactor and simplify convention plugins and build scripts Fixes #3132 --------- Co-authored-by: Adam <897017+aSemy@users.noreply.github.com> Co-authored-by: Oleg Yukhnevich --- .../maven-plugin/src/main/kotlin/PackageOptions.kt | 89 ---------------------- 1 file changed, 89 deletions(-) delete mode 100644 runners/maven-plugin/src/main/kotlin/PackageOptions.kt (limited to 'runners/maven-plugin/src/main/kotlin/PackageOptions.kt') diff --git a/runners/maven-plugin/src/main/kotlin/PackageOptions.kt b/runners/maven-plugin/src/main/kotlin/PackageOptions.kt deleted file mode 100644 index 875fb047..00000000 --- a/runners/maven-plugin/src/main/kotlin/PackageOptions.kt +++ /dev/null @@ -1,89 +0,0 @@ -/* - * Copyright 2014-2023 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license. - */ - -package org.jetbrains.dokka.maven - -import org.apache.maven.plugins.annotations.Parameter -import org.jetbrains.dokka.DokkaConfiguration -import org.jetbrains.dokka.DokkaDefaults - -/** - * Configuration block that allows setting some options for specific packages - * matched by [matchingRegex]. - * - * Example: - * - * ```xml - * - * - * - * .*api.* - * false - * false - * false - * - * PUBLIC - * PROTECTED - * - * - * - * - * ``` - */ -public class PackageOptions : DokkaConfiguration.PackageOptions { - - /** - * Regular expression that is used to match the package. - * - * If multiple packages match the same `matchingRegex`, the longest `matchingRegex` will be used. - * - * Default is any string: `.*`. - */ - @Parameter - override var matchingRegex: String = ".*" - - /** - * Whether this package should be skipped when generating documentation. - * - * Default is `false`. - */ - @Parameter - override var suppress: Boolean = DokkaDefaults.suppress - - /** - * List of visibility modifiers that should be documented. - * - * This can be used if you want to document protected/internal/private declarations within a - * specific package, as well as if you want to exclude public declarations and only document internal API. - * - * Default is [DokkaConfiguration.Visibility.PUBLIC]. - */ - @Parameter(property = "visibility") - override var documentedVisibilities: Set = DokkaDefaults.documentedVisibilities - - /** - * Whether to document declarations annotated with [Deprecated]. - * - * Can be set on project level with [AbstractDokkaMojo.skipDeprecated]. - * - * Default is `false`. - */ - @Parameter - override var skipDeprecated: Boolean = DokkaDefaults.skipDeprecated - - /** - * Whether to emit warnings about visible undocumented declarations, that is declarations from - * this package and without KDocs, after they have been filtered by [documentedVisibilities]. - * - * This setting works well with [AbstractDokkaMojo.failOnWarning]. - * - * Default is `false`. - */ - @Parameter - override var reportUndocumented: Boolean = DokkaDefaults.reportUndocumented - - @Parameter - @Deprecated("Use [documentedVisibilities] property for a more flexible control over documented visibilities") - override var includeNonPublic: Boolean = DokkaDefaults.includeNonPublic -} -- cgit