avail/avail.stacks.comment/GrammaticalRestrictionComment

GrammaticalRestrictionComment

class GrammaticalRestrictionComment(signature: CommentSignature, commentStartLine: Int, author: List<StacksAuthorTag>, sees: List<StacksSeeTag>, description: StacksDescription, categories: List<StacksCategoryTag>, aliases: List<StacksAliasTag>, forbids: MutableMap<Int, StacksForbidsTag>) : AvailComment

A comment implementation of grammatical restrictions

Author

Richard Arriaga

Parameters

signature

The signature of the class/method the comment describes.

commentStartLine

The start line in the module the comment being parsed appears.

author

The authors of the implementation.

sees

A list of any @sees references.

description

The overall description of the implementation.

categories

The categories the implementation appears in.

aliases

The aliases the implementation is known by.

forbids

The forbids tag contents.

Constructors

Link copied to clipboard
constructor(signature: CommentSignature, commentStartLine: Int, author: List<StacksAuthorTag>, sees: List<StacksSeeTag>, description: StacksDescription, categories: List<StacksCategoryTag>, aliases: List<StacksAliasTag>, forbids: MutableMap<Int, StacksForbidsTag>)

Construct a new GrammaticalRestrictionComment.

Properties

Link copied to clipboard
val categorySet: MutableSet<String>

A set of category String names for this implementation.

Link copied to clipboard
val isSticky: Boolean

Indicates whether or not the comment is sticky

Functions

Link copied to clipboard
open override fun addImplementationToImportModule(name: A_String, importModule: StacksImportModule)

Add the implementation to the provided StacksImportModule.

Link copied to clipboard
open override fun addToImplementationGroup(commentGroup: CommentGroup)

Add the implementation to the provided group.

Link copied to clipboard
fun identityCheck(): String

Create a string that is unique to this AvailComment.

Link copied to clipboard
open override fun toJSON(linkingFileMap: LinkingFileMap, nameOfGroup: String, errorLog: StacksErrorLog, jsonWriter: JSONWriter)

Create JSON content from implementation.

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