avail/avail.stacks.comment/ModuleComment

ModuleComment

class ModuleComment(signature: CommentSignature, commentStartLine: Int, author: MutableList<StacksAuthorTag>, sees: MutableList<StacksSeeTag>, description: StacksDescription, sticky: Boolean) : AvailComment

A comment that describes a particular module

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 author of the implementation.

sees

A List of any "@sees" references.

description

The overall description of the implementation

sticky

or not the method should be documented regardless of visibility

Constructors

Link copied to clipboard
constructor(signature: CommentSignature, commentStartLine: Int, author: MutableList<StacksAuthorTag>, sees: MutableList<StacksSeeTag>, description: StacksDescription, sticky: Boolean)

Construct a new ModuleComment.

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