CommentSignature

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

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

Author

Richard Arriaga

Parameters

name

The name of the class/method the comment describes.

module

The module this implementation appears in.

Constructors

Link copied to clipboard
fun CommentSignature(name: String, module: String)

Construct a new CommentSignature.

Functions

Link copied to clipboard
open fun toJSON(    nameOfGroup: String,     sticky: Boolean,     jsonWriter: JSONWriter)

Create the JSON representation of the signature.

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

Properties

Link copied to clipboard
val module: String

The module this implementation appears in.

Link copied to clipboard
val name: String

The name of the class/method the comment describes.

Inheritors

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard