Global
class GlobalComment( signature: CommentSignature, commentStartLine: Int, author: List<StacksAuthorTag>, sees: List<StacksSeeTag>, description: StacksDescription, categories: List<StacksCategoryTag>, aliases: List<StacksAliasTag>, globalTag: StacksGlobalTag) : AvailComment
Content copied to clipboard
A module global variable comment
Author
Richard Arriaga
Parameters
signature
The signature of the class/method the comment describes.
comment
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.
global
A global module variable comment tag.
Constructors
Link copied to clipboard
fun GlobalComment( signature: CommentSignature, commentStartLine: Int, author: List<StacksAuthorTag>, sees: List<StacksSeeTag>, description: StacksDescription, categories: List<StacksCategoryTag>, aliases: List<StacksAliasTag>, globalTag: StacksGlobalTag)
Content copied to clipboard
Construct a new GlobalComment.
Functions
Link copied to clipboard
open override fun addImplementationToImportModule(name: A_String, importModule: StacksImportModule)
Content copied to clipboard
Add the implementation to the provided StacksImportModule.
Link copied to clipboard
Add the implementation to the provided group.
Link copied to clipboard
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)
Content copied to clipboard
Create JSON content from implementation.