Package rife.bld.extension.dokka

Class SourceSet

java.lang.Object
rife.bld.extension.dokka.SourceSet
public class SourceSet extends Object
Configuration for a Dokka source set.
Since:
1.0
Author:
Erik C. Thauvin

  • Constructor Details

    • SourceSet

      public SourceSet()

  • Method Details

    • analysisPlatform

      public SourceSet analysisPlatform(AnalysisPlatform analysisPlatform)
      Sets the platform used for setting up analysis. Default is JVM

      Platform to be used for setting up code analysis and @sample environment.

      Parameters:
      analysisPlatform - the analysis platform
      Returns:
      this operation instance

    • apiVersion

      public SourceSet apiVersion(String apiVersion)
      Sets the Kotlin API version used for setting up analysis and samples.
      Parameters:
      apiVersion - the api version
      Returns:
      this operation instance

    • apiVersion

      public SourceSet apiVersion(int apiVersion)
      Sets the Kotlin API version used for setting up analysis and samples.
      Parameters:
      apiVersion - the api version
      Returns:
      this operation instance

    • args

      public List<String> args()
      Returns the formatted arguments.
      Returns:
      the arguments

    • classpath

      public SourceSet classpath(File... files)
      Sets classpath for analysis and interactive samples.

      This is useful if some types that come from dependencies are not resolved/picked up automatically.

      This option accepts both .jar and .klib files.

      Parameters:
      files - one or more file
      Returns:
      this operation instance
      See Also:

    • classpath

      public SourceSet classpath(String... files)
      Sets classpath for analysis and interactive samples.

      This is useful if some types that come from dependencies are not resolved/picked up automatically.

      This option accepts both .jar and .klib files.

      Parameters:
      files - one or more file
      Returns:
      this operation instance
      See Also:

    • classpath

      public SourceSet classpath(Path... files)
      Sets classpath for analysis and interactive samples.

      This is useful if some types that come from dependencies are not resolved/picked up automatically.

      This option accepts both .jar and .klib files.

      Parameters:
      files - one or more file
      Returns:
      this operation instance
      See Also:

    • classpath

      public SourceSet classpath(Collection<File> files)
      Sets classpath for analysis and interactive samples.

      This is useful if some types that come from dependencies are not resolved/picked up automatically.

      This option accepts both .jar and .klib files.

      Parameters:
      files - the collection of files
      Returns:
      this operation instance
      See Also:

    • classpath

      public Collection<File> classpath()
      Retrieves the classpath for analysis and interactive samples.
      Returns:
      the classpath

    • classpathPaths

      public SourceSet classpathPaths(Collection<Path> files)
      Sets classpath for analysis and interactive samples.

      This is useful if some types that come from dependencies are not resolved/picked up automatically.

      This option accepts both .jar and .klib files.

      Parameters:
      files - the collection of files
      Returns:
      this operation instance
      See Also:

    • classpathStrings

      public SourceSet classpathStrings(Collection<String> files)
      Sets classpath for analysis and interactive samples.

      This is useful if some types that come from dependencies are not resolved/picked up automatically.

      This option accepts both .jar and .klib files.

      Parameters:
      files - the collection of files
      Returns:
      this operation instance
      See Also:

    • dependentSourceSets

      public SourceSet dependentSourceSets(String moduleName, String sourceSetName)
      Sets the names of dependent source sets.
      Parameters:
      moduleName - the module name
      sourceSetName - the source set name
      Returns:
      this operation instance

    • dependentSourceSets

      public Map<String,String> dependentSourceSets()
      Retrieves the names of dependent source sets.
      Returns:
      the names

    • dependentSourceSets

      public SourceSet dependentSourceSets(Map<String,String> dependentSourceSets)
      Sets the names of dependent source sets.
      Parameters:
      dependentSourceSets - the map of dependent source set names
      Returns:
      this operation instance
      See Also:

    • displayName

      public SourceSet displayName(String displayName)
      Sets the display name of the source set, used both internally and externally.

      The name is used both externally (for example, the source set name is visible to documentation readers) and internally (for example, for logging messages of reportUndocumented).

      The platform name can be used if you don't have a better alternative.

      Parameters:
      displayName - the display name
      Returns:
      this operation instance

    • documentedVisibilities

      public SourceSet documentedVisibilities(DocumentedVisibility... visibilities)
      Sets visibilities to be documented.

      This can be used if you want to document protected/internal/private declarations, as well as if you want to exclude public declarations and only document internal API.

      This can be configured on per-package basis.

      Parameters:
      visibilities - one or more visibilities
      Returns:
      this operation instance

    • documentedVisibilities

      public Collection<DocumentedVisibility> documentedVisibilities()
      Retrieves the visibilities to be documented.
      Returns:
      the documented visibilities

    • externalDocumentationLinks

      public SourceSet externalDocumentationLinks(String url, String packageListUrl)
      Sets the external documentation links.

      A set of parameters for external documentation links that is applied only for this source set.

      Parameters:
      url - the external documentation URL
      packageListUrl - the external documentation package list URL
      Returns:
      this operation instance

    • externalDocumentationLinks

      public Map<String,String> externalDocumentationLinks()
      Retrieves the external documentation links.
      Returns:
      the documentation links.

    • externalDocumentationLinks

      public SourceSet externalDocumentationLinks(Map<String,String> externalDocumentationLinks)
      Sets the external documentation links.

      A set of parameters for external documentation links that is applied only for this source set.

      Parameters:
      externalDocumentationLinks - the map of external documentation links
      Returns:
      this operation instance
      See Also:

    • includes

      public SourceSet includes(File... files)
      Sets the Markdown files that contain module and package documentation.

      The Markdown files that contain module and package documentation.

      The contents of the specified files are parsed and embedded into documentation as module and package descriptions.

      Parameters:
      files - one or more files
      Returns:
      this operation instance
      See Also:

    • includes

      public SourceSet includes(String... files)
      Sets the Markdown files that contain module and package documentation.

      The Markdown files that contain module and package documentation.

      The contents of the specified files are parsed and embedded into documentation as module and package descriptions.

      Parameters:
      files - one or more files
      Returns:
      this operation instance
      See Also:

    • includes

      public SourceSet includes(Path... files)
      Sets the Markdown files that contain module and package documentation.

      The Markdown files that contain module and package documentation.

      The contents of the specified files are parsed and embedded into documentation as module and package descriptions.

      Parameters:
      files - one or more files
      Returns:
      this operation instance
      See Also:

    • includes

      public Collection<File> includes()
      Retrieves the Markdown files that contain module and package documentation.
      Returns:
      the markdown files

    • includes

      public SourceSet includes(Collection<File> files)
      Sets the Markdown files that contain module and package documentation.

      The Markdown files that contain module and package documentation.

      The contents of the specified files are parsed and embedded into documentation as module and package descriptions.

      Parameters:
      files - the collection of files
      Returns:
      this operation instance
      See Also:

    • includesPaths

      public SourceSet includesPaths(Collection<Path> files)
      Sets the Markdown files that contain module and package documentation.

      The Markdown files that contain module and package documentation.

      The contents of the specified files are parsed and embedded into documentation as module and package descriptions.

      Parameters:
      files - the collection of files
      Returns:
      this operation instance
      See Also:

    • includesStrings

      public SourceSet includesStrings(Collection<String> files)
      Sets the Markdown files that contain module and package documentation.

      The Markdown files that contain module and package documentation.

      The contents of the specified files are parsed and embedded into documentation as module and package descriptions.

      Parameters:
      files - the collection of files
      Returns:
      this operation instance
      See Also:

    • jdkVersion

      public SourceSet jdkVersion(String jdkVersion)
      Sets the version of JDK to use for linking to JDK Javadocs.

      The JDK version to use when generating external documentation links for Java types.

      For example, if you use UUID in some public declaration signature, and this option is set to 8, Dokka generates an external documentation link to JDK 8 Javadocs for it.

      Parameters:
      jdkVersion - the JDK version
      Returns:
      this operation instance

    • jdkVersion

      public String jdkVersion()
      Retrieves the version of the JDK to use for linking to JDK Javadocs.
      Returns:
      the JDK version.

    • jdkVersion

      public SourceSet jdkVersion(int jdkVersion)
      Sets the version of JDK to use for linking to JDK Javadocs.

      The JDK version to use when generating external documentation links for Java types.

      For example, if you use UUID in some public declaration signature, and this option is set to 8, Dokka generates an external documentation link to JDK 8 Javadocs for it.

      Parameters:
      jdkVersion - the JDK version
      Returns:
      this operation instance

    • languageVersion

      public SourceSet languageVersion(String languageVersion)
      Sets the language version used for setting up analysis and samples.
      Parameters:
      languageVersion - the language version
      Returns:
      this operation instance

    • languageVersion

      public SourceSet languageVersion(int languageVersion)
      Sets the language version used for setting up analysis and samples.
      Parameters:
      languageVersion - the language version
      Returns:
      this operation instance

    • noJdkLink

      public SourceSet noJdkLink(Boolean noJdkLink)
      Sets whether to generate links to JDK Javadocs.

      Whether to generate external documentation links to JDK's Javadocs.

      The version of JDK Javadocs is determined by the jdkVersion option.

      Note: Links are generated when noJdkLink is set to false.

      Parameters:
      noJdkLink - true or false
      Returns:
      this operation instance

    • noSkipEmptyPackages

      public SourceSet noSkipEmptyPackages(boolean noSkipEmptyPackages)
      Sets whether to create pages for empty packages.

      Whether to skip packages that contain no visible declarations after various filters have been applied.

      Parameters:
      noSkipEmptyPackages - true or false
      Returns:
      this operation instance

    • noStdlibLink

      public SourceSet noStdlibLink(Boolean noStdlibLink)
      Sets whether to generate links to Standard library.

      Whether to generate external documentation links that lead to the API reference documentation of Kotlin's standard library.

      Note: Links are generated when noStdLibLink is set to false.

      Parameters:
      noStdlibLink - true or false
      Returns:
      this operation instance

    • perPackageOptions

      public SourceSet perPackageOptions(Collection<String> perPackageOptions)
      Set the package source set configuration.

      A set of parameters specific to matched packages within this source set.

      Using format:

      • matchingRegexp
      • -deprecated
      • -privateApi
      • +warnUndocumented
      • +suppress
      • +visibility:PUBLIC
      • ...
      Parameters:
      perPackageOptions - the per package options
      Returns:
      this operation instance

    • perPackageOptions

      public Collection<String> perPackageOptions()
      Retrieves the package source set configuration.
      Returns:
      the package source set configuration

    • perPackageOptions

      public SourceSet perPackageOptions(String... perPackageOptions)
      Set the package source set configuration.

      A set of parameters specific to matched packages within this source set.

      Using format:

      • matchingRegexp
      • -deprecated
      • -privateApi
      • +warnUndocumented
      • +suppress
      • +visibility:PUBLIC
      • ...
      Parameters:
      perPackageOptions - the per package options
      Returns:
      this operation instance

    • reportUndocumented

      public SourceSet reportUndocumented(Boolean reportUndocumented)
      Sets whether to report undocumented declarations.

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

      This setting works well with DokkaOperation.failOnWarning(java.lang.Boolean).

      This can be configured on per-package basis.

      Parameters:
      reportUndocumented - true or false
      Returns:
      this operation instance

    • samples

      public SourceSet samples(Collection<File> samples)
      Set the directories or files that contain sample functions.

      The directories or files that contain sample functions which are referenced via the @sample KDoc tag.

      Parameters:
      samples - the samples
      Returns:
      this operation instance
      See Also:

    • samples

      public Collection<File> samples()
      Retrieves the directories or files that contain sample functions.
      Returns:
      the directories or files

    • samples

      public SourceSet samples(File... samples)
      Set the directories or files that contain sample functions.

      The directories or files that contain sample functions which are referenced via the @sample KDoc tag.

      Parameters:
      samples - nne or more samples
      Returns:
      this operation instance
      See Also:

    • samples

      public SourceSet samples(String... samples)
      Set the directories or files that contain sample functions.

      The directories or files that contain sample functions which are referenced via the @sample KDoc tag.

      Parameters:
      samples - nne or more samples
      Returns:
      this operation instance
      See Also:

    • samples

      public SourceSet samples(Path... samples)
      Set the directories or files that contain sample functions.

      The directories or files that contain sample functions which are referenced via the @sample KDoc tag.

      Parameters:
      samples - nne or more samples
      Returns:
      this operation instance
      See Also:

    • samplesPaths

      public SourceSet samplesPaths(Collection<Path> samples)
      Set the directories or files that contain sample functions.

      The directories or files that contain sample functions which are referenced via the @sample KDoc tag.

      Parameters:
      samples - the samples
      Returns:
      this operation instance
      See Also:

    • samplesStrings

      public SourceSet samplesStrings(Collection<String> samples)
      Set the directories or files that contain sample functions.

      The directories or files that contain sample functions which are referenced via the @sample KDoc tag.

      Parameters:
      samples - the samples
      Returns:
      this operation instance
      See Also:

    • skipDeprecated

      public SourceSet skipDeprecated(boolean skipDeprecated)
      Sets whether to skip deprecated declarations.

      Whether to document declarations annotated with @Deprecated.

      This can be configured on per-package basis.

      Parameters:
      skipDeprecated - true or false
      Returns:
      this operation instance

    • sourceSetName

      public SourceSet sourceSetName(String sourceSetName)
      Sets the name of the source set. Default is main.
      Parameters:
      sourceSetName - the source set name.
      Returns:
      this operation instance

    • src

      public SourceSet src(Collection<File> src)
      Sets the source code roots to be analyzed and documented.

      The source code roots to be analyzed and documented. Acceptable inputs are directories and individual .kt / .java files.

      Parameters:
      src - the source code roots
      Returns:
      this operation instance
      See Also:

    • src

      public SourceSet src(File... src)
      Sets the source code roots to be analyzed and documented.

      The source code roots to be analyzed and documented. Acceptable inputs are directories and individual .kt / .java files.

      Parameters:
      src - pne ore moe source code roots
      Returns:
      this operation instance
      See Also:

    • src

      public SourceSet src(String... src)
      Sets the source code roots to be analyzed and documented.

      The source code roots to be analyzed and documented. Acceptable inputs are directories and individual .kt / .java files.

      Parameters:
      src - pne ore moe source code roots
      Returns:
      this operation instance
      See Also:

    • src

      public SourceSet src(Path... src)
      Sets the source code roots to be analyzed and documented.

      The source code roots to be analyzed and documented. Acceptable inputs are directories and individual .kt / .java files.

      Parameters:
      src - pne ore moe source code roots
      Returns:
      this operation instance
      See Also:

    • src

      public Collection<File> src()
      Retrieves the source code roots to be analyzed and documented.
      Returns:
      the source code roots

    • srcLink

      public SourceSet srcLink(String srcPath, String remotePath, String lineSuffix)
      Sets the mapping between a source directory and a Web service for browsing the code.
      Parameters:
      srcPath - the source path
      remotePath - the remote path
      lineSuffix - the line suffix
      Returns:
      this operation instance

    • srcLink

      public SourceSet srcLink(File srcPath, String remotePath, String lineSuffix)
      Sets the mapping between a source directory and a Web service for browsing the code.
      Parameters:
      srcPath - the source path
      remotePath - the remote path
      lineSuffix - the line suffix
      Returns:
      this operation instance

    • srcLink

      public SourceSet srcLink(Path srcPath, String remotePath, String lineSuffix)
      Sets the mapping between a source directory and a Web service for browsing the code.
      Parameters:
      srcPath - the source path
      remotePath - the remote path
      lineSuffix - the line suffix
      Returns:
      this operation instance

    • srcLinks

      public Map<String,String> srcLinks()
      Retrieves the mapping between a source directory and a Web service for browsing the code.
      Returns:
      the source links

    • srcPaths

      public SourceSet srcPaths(Collection<Path> src)
      Sets the source code roots to be analyzed and documented.

      The source code roots to be analyzed and documented. Acceptable inputs are directories and individual .kt / .java files.

      Parameters:
      src - the source code roots
      Returns:
      this operation instance
      See Also:

    • srcStrings

      public SourceSet srcStrings(Collection<String> src)
      Sets the source code roots to be analyzed and documented.

      The source code roots to be analyzed and documented. Acceptable inputs are directories and individual .kt / .java files.

      Parameters:
      src - the source code roots
      Returns:
      this operation instance
      See Also:

    • suppressedFiles

      public SourceSet suppressedFiles(Collection<File> suppressedFiles)
      Sets the paths to files to be suppressed.

      The files to be suppressed when generating documentation.

      Parameters:
      suppressedFiles - the suppressed files
      Returns:
      this operation instance
      See Also:

    • suppressedFiles

      public Collection<File> suppressedFiles()
      Retrieves the paths to files to be suppressed.
      Returns:
      the paths

    • suppressedFiles

      public SourceSet suppressedFiles(String... suppressedFiles)
      Sets the paths to files to be suppressed.

      The files to be suppressed when generating documentation.

      Parameters:
      suppressedFiles - one or moe suppressed files
      Returns:
      this operation instance
      See Also:

    • suppressedFiles

      public SourceSet suppressedFiles(File... suppressedFiles)
      Sets the paths to files to be suppressed.

      The files to be suppressed when generating documentation.

      Parameters:
      suppressedFiles - one or moe suppressed files
      Returns:
      this operation instance
      See Also:

    • suppressedFiles

      public SourceSet suppressedFiles(Path... suppressedFiles)
      Sets the paths to files to be suppressed.

      The files to be suppressed when generating documentation.

      Parameters:
      suppressedFiles - one or moe suppressed files
      Returns:
      this operation instance
      See Also:

    • suppressedFilesPaths

      public SourceSet suppressedFilesPaths(Collection<Path> suppressedFiles)
      Sets the paths to files to be suppressed.

      The files to be suppressed when generating documentation.

      Parameters:
      suppressedFiles - the suppressed files
      Returns:
      this operation instance
      See Also:

    • suppressedFilesStrings

      public SourceSet suppressedFilesStrings(Collection<String> suppressedFiles)
      Sets the paths to files to be suppressed.

      The files to be suppressed when generating documentation.

      Parameters:
      suppressedFiles - the suppressed files
      Returns:
      this operation instance
      See Also: