Semantic
class SemanticRestrictionComment( signature: SemanticRestrictionCommentSignature, commentStartLine: Int, author: List<StacksAuthorTag>, sees: List<StacksSeeTag>, description: StacksDescription, categories: List<StacksCategoryTag>, aliases: List<StacksAliasTag>, restricts: List<StacksRestrictsTag>, returnsContent: List<StacksReturnTag>) : AvailComment
Content copied to clipboard
A comment implementation of grammatical restrictions
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 authors 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.
restricts
The list of input types in the semantic restriction.
returns
The @returns content
Constructors
Link copied to clipboard
fun SemanticRestrictionComment( signature: SemanticRestrictionCommentSignature, commentStartLine: Int, author: List<StacksAuthorTag>, sees: List<StacksSeeTag>, description: StacksDescription, categories: List<StacksCategoryTag>, aliases: List<StacksAliasTag>, restricts: List<StacksRestrictsTag>, returnsContent: List<StacksReturnTag>)
Content copied to clipboard
Construct a new SemanticRestrictionComment.
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.