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

PackageOptions

class PackageOptions : DokkaConfiguration.PackageOptions

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
constructor()

Properties

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

List of visibility modifiers that should be documented.

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

Regular expression that is used to match the package.

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

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

Whether to document declarations annotated with Deprecated.

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

Whether this package should be skipped when generating documentation.