avail/avail.stacks.comment.signature/SemanticRestrictionCommentSignature

SemanticRestrictionCommentSignature

class SemanticRestrictionCommentSignature(val name: String, val module: String, orderedInputTypes: MutableList<String>) : CommentSignature

The defining characteristic of a semantic restriction 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.

orderedInputTypes

The semantic restriction parameter input types in order of input

Constructors

Link copied to clipboard
constructor(name: String, module: String, orderedInputTypes: MutableList<String>)

Construct a new SemanticRestrictionCommentSignature.

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.

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