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

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

fun MethodComment( 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.

Add the implementation to the provided StacksImportModule.

Add the implementation to the provided group.

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

A set of category String names for this implementation.

Indicates whether or not the comment is sticky

The "@returns" content