avail/avail.stacks.comment/AvailComment

AvailComment

abstract class AvailComment

An abstract Avail comment.

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.

authors

The author 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.

isSticky

Indicates whether or not the comment is sticky.

Inheritors

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
abstract fun addImplementationToImportModule(name: A_String, importModule: StacksImportModule)

Add the implementation to the provided StacksImportModule.

Link copied to clipboard
abstract 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
abstract fun toJSON(linkingFileMap: LinkingFileMap, nameOfGroup: String, errorLog: StacksErrorLog, jsonWriter: JSONWriter)

Create JSON content from implementation.