MacroComment

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

A comment that describes a particular macro implementation

Richard Arriaga

Parameters

signature

The signature of the macro 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 MacroComment( signature: MethodCommentSignature, commentStartLine: Int, author: List<StacksAuthorTag>, sees: List<StacksSeeTag>, description: StacksDescription, categories: List<StacksCategoryTag>, aliases: List<StacksAliasTag>, parameters: List<StacksParameterTag>, returnsContent: StacksReturnTag, exceptions: List<StacksRaisesTag>, sticky: Boolean)

Construct a new MacroComment.

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.

A list of any exceptions the method throws.

Indicates whether or not the comment is sticky