Properties

Link copied to clipboard

List of @author tags.

Link copied to clipboard

The @constructor tag.

Link copied to clipboard
abstract val description: String

Description of the declaration.

Link copied to clipboard

List of @exception tags.

Link copied to clipboard
abstract val hasAuthorTags: Boolean

Determines whatever the declaration has author tags.

Link copied to clipboard

Determines whatever the declaration has constructor tag.

Link copied to clipboard

Determines whatever the declaration has exception tags.

Link copied to clipboard
abstract val hasParamTags: Boolean

Determines whatever the declaration has param tags.

Link copied to clipboard

Determines whatever the declaration has property getter tag.

Link copied to clipboard

Determines whatever the declaration has property setter tag.

Link copied to clipboard
abstract val hasPropertyTags: Boolean

Determines whatever the declaration has property tags.

Link copied to clipboard
abstract val hasReceiverTag: Boolean

Determines whatever the declaration has receiver tag.

Link copied to clipboard
abstract val hasReturnTag: Boolean

Determines whatever the declaration has return tag.

Link copied to clipboard
abstract val hasSampleTags: Boolean

Determines whatever the declaration has sample tags.

Link copied to clipboard
abstract val hasSeeTags: Boolean

Determines whatever the declaration has see tags.

Link copied to clipboard
abstract val hasSinceTag: Boolean

Determines whatever the declaration has since tag.

Link copied to clipboard
abstract val hasSuppressTag: Boolean

Determines whatever the declaration has suppress tag.

Link copied to clipboard
abstract val hasThrowsTags: Boolean

Determines whatever the declaration has throws tags.

Link copied to clipboard
abstract val hasVersionTag: Boolean

Determines whatever the declaration has version tag.

Link copied to clipboard
abstract val location: String

Location of the declaration containing the file path, line and column.

Link copied to clipboard
abstract val locationWithText: String

Text of the declaration with the location (file path, line and column).

Link copied to clipboard
abstract val moduleName: String

The declaration's module name.

Link copied to clipboard
abstract val numAuthorTags: Int

The number of author tags.

Link copied to clipboard
abstract val numExceptionTags: Int

The number of exception tags.

Link copied to clipboard
abstract val numParamTags: Int

The number of param tags.

Link copied to clipboard
abstract val numPropertyTags: Int

The number of property tags.

Link copied to clipboard
abstract val numSampleTags: Int

The number of sample tags.

Link copied to clipboard
abstract val numSeeTags: Int

The number of see tags.

Link copied to clipboard
abstract val numTags: Int

The number of tags.

Link copied to clipboard
abstract val numThrowsTags: Int

The number of throws tags.

Link copied to clipboard

List of @param tags.

Link copied to clipboard
abstract val path: String

File path of the declaration or path of the file.

Link copied to clipboard
abstract val projectPath: String

Project file path of the declaration or root project path of the file.

Link copied to clipboard

The @propertyGetter tag.

Link copied to clipboard

The @propertySetter tag.

Link copied to clipboard

List of @property tags.

Link copied to clipboard

The @receiver tag.

Link copied to clipboard

The @return tag.

Link copied to clipboard

List of @sample tags.

Link copied to clipboard

List of @see tags.

Link copied to clipboard

The @since tag.

Link copied to clipboard
abstract val sourceSetName: String

The declaration's source set name.

Link copied to clipboard

The @suppress tag.

Link copied to clipboard

List of tags.

Link copied to clipboard
abstract val text: String

Text of the declaration.

Link copied to clipboard

List of @throws tags.

Link copied to clipboard

The @version tag.

Functions

Link copied to clipboard
abstract fun hasAllTags(tags: Collection<KoKDocTag>): Boolean
abstract fun hasAllTags(tag: KoKDocTag, vararg tags: KoKDocTag): Boolean

Determines whether the declaration has all specified tags.

Link copied to clipboard
abstract fun hasTag(tags: Collection<KoKDocTag>): Boolean
abstract fun hasTag(tag: KoKDocTag, vararg tags: KoKDocTag): Boolean

Determines whether the declaration has at least one specified tag.

Link copied to clipboard
abstract fun hasTags(): Boolean

Determines whatever the declaration has tags.

Link copied to clipboard
abstract fun hasTextContaining(str: String): Boolean

Text of the declaration containing text.

Link copied to clipboard
abstract fun hasTextEndingWith(suffix: String): Boolean

Text of the declaration with suffix.

Link copied to clipboard
abstract fun hasTextMatching(regex: Regex): Boolean

Text of the declaration matching regex.

Link copied to clipboard
abstract fun hasTextStartingWith(prefix: String): Boolean

Text of the declaration with prefix.

Link copied to clipboard
abstract fun resideInModule(name: String): Boolean

Determines whatever declaration reside in module.

Link copied to clipboard
abstract fun resideInPath(path: String, absolutePath: Boolean = false): Boolean

Determines whatever declaration reside in file path or file reside in path.

Link copied to clipboard
abstract fun resideInSourceSet(sourceSetName: String): Boolean

Determines whatever declaration reside in source set.

Link copied to clipboard
abstract override fun toString(): String

String representing the declaration.