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

GlobalCommentSignature

fun GlobalCommentSignature( name: String, module: String, globalType: String)

Construct a new GlobalCommentSignature.

Functions

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

Create the JSON representation of the signature.

open override fun toString(): String

Properties

val globalType: String

The type of the global module variable.

val module: String

The module this implementation appears in.

val name: String

The name of the class/method the comment describes.