DokkaSourceSetBuilder

class DokkaSourceSetBuilder(moduleName: String, var name: String = "main", var displayName: String = "JVM", var classpath: List<String> = emptyList(), var sourceRoots: List<String> = emptyList(), var dependentSourceSets: Set<DokkaSourceSetID> = emptySet(), var samples: List<String> = emptyList(), var includes: List<String> = emptyList(), var includeNonPublic: Boolean = false, var documentedVisibilities: Set<DokkaConfiguration.Visibility> = DokkaDefaults.documentedVisibilities, var reportUndocumented: Boolean = false, var skipEmptyPackages: Boolean = false, var skipDeprecated: Boolean = false, var jdkVersion: Int = 8, var languageVersion: String? = null, var apiVersion: String? = null, var noStdlibLink: Boolean = false, var noJdkLink: Boolean = false, var suppressedFiles: List<String> = emptyList(), var analysisPlatform: String = "jvm", var perPackageOptions: List<PackageOptionsImpl> = emptyList(), var externalDocumentationLinks: List<ExternalDocumentationLinkImpl> = emptyList(), var sourceLinks: List<SourceLinkDefinitionImpl> = emptyList())

Constructors

Link copied to clipboard
constructor(moduleName: String, name: String = "main", displayName: String = "JVM", classpath: List<String> = emptyList(), sourceRoots: List<String> = emptyList(), dependentSourceSets: Set<DokkaSourceSetID> = emptySet(), samples: List<String> = emptyList(), includes: List<String> = emptyList(), includeNonPublic: Boolean = false, documentedVisibilities: Set<DokkaConfiguration.Visibility> = DokkaDefaults.documentedVisibilities, reportUndocumented: Boolean = false, skipEmptyPackages: Boolean = false, skipDeprecated: Boolean = false, jdkVersion: Int = 8, languageVersion: String? = null, apiVersion: String? = null, noStdlibLink: Boolean = false, noJdkLink: Boolean = false, suppressedFiles: List<String> = emptyList(), analysisPlatform: String = "jvm", perPackageOptions: List<PackageOptionsImpl> = emptyList(), externalDocumentationLinks: List<ExternalDocumentationLinkImpl> = emptyList(), sourceLinks: List<SourceLinkDefinitionImpl> = emptyList())

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
var dependentSourceSets: Set<DokkaSourceSetID>
Link copied to clipboard
Link copied to clipboard
var documentedVisibilities: Set<DokkaConfiguration.Visibility>
Link copied to clipboard
var externalDocumentationLinks: List<ExternalDocumentationLinkImpl>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
var perPackageOptions: List<PackageOptionsImpl>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
var sourceLinks: List<SourceLinkDefinitionImpl>
Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
fun build(): DokkaSourceSetImpl