CommentSignature

open class CommentSignature(val name: String, val module: String)

The defining characteristic of a comment as it pertains to the implementation it describes.

Richard Arriaga

name

The name of the class/method the comment describes.

module

The module this implementation appears in.

Constructors

constructor(name: String, module: String)

Construct a new CommentSignature.

The module this implementation appears in.

The name of the class/method the comment describes.

open fun toJSON(nameOfGroup: String, sticky: Boolean, jsonWriter: JSONWriter)

Create the JSON representation of the signature.

open override fun toString(): String