KDocCommentDescriptor¶

@SubclassOptInRequired(markerClass = [KtImplementationDetail::class])
interface KDocCommentDescriptor

A view of a KDoc comment.

This is part of a non-public API intended for use only by IDE and Dokka. Current implementation is based on the original findKDoc logic from Kotlin IDE Plugin.

• If the symbol owns the KDoc, primaryTag is the KDoc's default section and additionalSections contains all sections of that KDoc (including the default one).

• For a primary constructor, if the enclosing class KDoc has an @constructor section, that section is used as primaryTag, and additionalSections contains the sections that include @param tags from the class's KDoc.

• In some cases KDoc for a symbol may be extracted from the KDoc of a parent element. Examples:

• a property-parameter of the primary constructor;

• a type parameter;

• a property of a class/object referenced with a @property tag in the class/object KDoc.