avail/avail.stacks.comment.signature/GlobalCommentSignature

GlobalCommentSignature

class GlobalCommentSignature(val name: String, val module: String, val globalType: String) : CommentSignature

GLOBAL Comment Signature

Author

Richard Arriaga

Parameters

name
module
globalType

The type of the global module variable.

Constructors

Link copied to clipboard
constructor(name: String, module: String, globalType: String)

Construct a new GlobalCommentSignature.

Properties

Link copied to clipboard
val globalType: String

The type of the global module variable.

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.

Functions

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

Create the JSON representation of the signature.

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