avail/avail.stacks.comment/MethodComment

MethodComment

class MethodComment(signature: MethodCommentSignature, commentStartLine: Int, author: MutableList<StacksAuthorTag>, sees: MutableList<StacksSeeTag>, description: StacksDescription, categories: MutableList<StacksCategoryTag>, aliases: MutableList<StacksAliasTag>, parameters: MutableList<StacksParameterTag>, val returnsContent: StacksReturnTag, exceptions: MutableList<StacksRaisesTag>, sticky: Boolean) : AvailComment

A comment that describes a particular method implementation

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

categories

The categories the implementation appears in

aliases

The aliases the implementation is known by

parameters

The list of parameters of the method implementation.

returnsContent

The "@returns" content

exceptions

A MutableList of any exceptions the method throws.

sticky

Whether or not the method should be documented regardless of visibility

Constructors

constructor(signature: MethodCommentSignature, commentStartLine: Int, author: MutableList<StacksAuthorTag>, sees: MutableList<StacksSeeTag>, description: StacksDescription, categories: MutableList<StacksCategoryTag>, aliases: MutableList<StacksAliasTag>, parameters: MutableList<StacksParameterTag>, returnsContent: StacksReturnTag, exceptions: MutableList<StacksRaisesTag>, sticky: Boolean)

Construct a new MethodComment.

Properties

val categorySet: MutableSet<String>

A set of category String names for this implementation.

val isSticky: Boolean

Indicates whether or not the comment is sticky

val returnsContent: StacksReturnTag

The "@returns" content

Functions

addImplementationToImportModule

open override fun addImplementationToImportModule(name: A_String, importModule: StacksImportModule)

Add the implementation to the provided StacksImportModule.

addToImplementationGroup

open override fun addToImplementationGroup(commentGroup: CommentGroup)

Add the implementation to the provided group.

fun identityCheck(): String

Create a string that is unique to this AvailComment.

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

Create JSON content from implementation.

open override fun toString(): String