maven-plugin/org.jetbrains.dokka.maven/PackageOptions

PackageOptions

class PackageOptions : DokkaConfiguration.PackageOptions
Content copied to clipboard

Configuration block that allows setting some options for specific packages matched by matchingRegex.

Example:

<configuration>
    <perPackageOptions>
        <packageOptions>
            <matchingRegex>.*api.*</matchingRegex>
            <suppress>false</suppress>
            <reportUndocumented>false</reportUndocumented>
            <skipDeprecated>false</skipDeprecated>
            <documentedVisibilities>
                <visibility>PUBLIC</visibility>
                <visibility>PROTECTED</visibility>
            </documentedVisibilities>
        </packageOptions>
    </perPackageOptions>
</configuration>
Content copied to clipboard

Constructors

Link copied to clipboard
fun PackageOptions()
Content copied to clipboard

Properties

Link copied to clipboard
@Parameter(property = "visibility")
open override var documentedVisibilities: Set<DokkaConfiguration.Visibility>
Content copied to clipboard

List of visibility modifiers that should be documented.

Link copied to clipboard
@Parameter
open override var includeNonPublic: Boolean
Content copied to clipboard
Link copied to clipboard
@Parameter
open override var matchingRegex: String
Content copied to clipboard

Regular expression that is used to match the package.

Link copied to clipboard
@Parameter
open override var reportUndocumented: Boolean
Content copied to clipboard

Whether to emit warnings about visible undocumented declarations, that is declarations from this package and without KDocs, after they have been filtered by documentedVisibilities.

Link copied to clipboard
@Parameter
open override var skipDeprecated: Boolean
Content copied to clipboard

Whether to document declarations annotated with Deprecated.

Link copied to clipboard
@Parameter
open override var suppress: Boolean
Content copied to clipboard

Whether this package should be skipped when generating documentation.