Module
class ModuleComment( signature: CommentSignature, commentStartLine: Int, author: MutableList<StacksAuthorTag>, sees: MutableList<StacksSeeTag>, description: StacksDescription, sticky: Boolean) : AvailComment
Content copied to clipboard
A comment that describes a particular module
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.
description
The overall description of the implementation
sticky
or not the method should be documented regardless of visibility
Constructors
Link copied to clipboard
fun ModuleComment( signature: CommentSignature, commentStartLine: Int, author: MutableList<StacksAuthorTag>, sees: MutableList<StacksSeeTag>, description: StacksDescription, sticky: Boolean)
Content copied to clipboard
Construct a new ModuleComment.
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.