Class
class ClassComment( signature: CommentSignature, commentStartLine: Int, author: List<StacksAuthorTag>, sees: List<StacksSeeTag>, description: StacksDescription, categories: List<StacksCategoryTag>, aliases: List<StacksAliasTag>, supertypes: List<StacksSuperTypeTag>, fields: List<StacksFieldTag>, sticky: Boolean) : AvailComment
Content copied to clipboard
A comment that describes a particular class.
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 is known by
supertypes
The list of the class's supertypes
fields
The list of the class's fields
sticky
Whether or not the method should be documented regardless of visibility
Constructors
Link copied to clipboard
fun ClassComment( signature: CommentSignature, commentStartLine: Int, author: List<StacksAuthorTag>, sees: List<StacksSeeTag>, description: StacksDescription, categories: List<StacksCategoryTag>, aliases: List<StacksAliasTag>, supertypes: List<StacksSuperTypeTag>, fields: List<StacksFieldTag>, sticky: Boolean)
Content copied to clipboard
Construct a new ClassComment.
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.