avail/avail.stacks.comment/CommentBuilder

CommentBuilder

class CommentBuilder
Content copied to clipboard

A builder class for an AvailComment.

Author

Richard Arriaga

Parameters

moduleName

The name of the module the comment is in.

commentStartLine

The start line in the module of the comment being built

linkingFileMap

Types

Link copied to clipboard
object Companion
Content copied to clipboard

Functions

Link copied to clipboard
fun addStacksAliasTag(tagContentTokens: List<AbstractStacksToken>, fileMap: LinkingFileMap)
Content copied to clipboard
Link copied to clipboard
fun addStacksAuthorTag(tagContentTokens: List<AbstractStacksToken>)
Content copied to clipboard
Link copied to clipboard
fun addStacksCategoryTag(tagContentTokens: List<AbstractStacksToken>, fileMap: LinkingFileMap)
Content copied to clipboard
Link copied to clipboard
fun addStacksCommentDescription(list: List<AbstractStacksToken>)
Content copied to clipboard
Link copied to clipboard
fun addStacksFieldTag(tagContentTokens: List<AbstractStacksToken>)
Content copied to clipboard
Link copied to clipboard
fun addStacksForbidTag(tagContentTokens: List<AbstractStacksToken>)
Content copied to clipboard
Link copied to clipboard
fun addStacksGlobalTag(tagContentTokens: List<AbstractStacksToken>)
Content copied to clipboard
Link copied to clipboard
fun addStacksMacroTag(tagContentTokens: List<AbstractStacksToken>)
Content copied to clipboard
Link copied to clipboard
fun addStacksMethodTag(tagContentTokens: List<AbstractStacksToken>)
Content copied to clipboard
Link copied to clipboard
fun addStacksModuleTag(tagContentTokens: List<AbstractStacksToken>)
Content copied to clipboard
Link copied to clipboard
fun addStacksParameterTag(tagContentTokens: List<AbstractStacksToken>)
Content copied to clipboard
Link copied to clipboard
fun addStacksRaisesTag(tagContentTokens: List<AbstractStacksToken>)
Content copied to clipboard
Link copied to clipboard
fun addStacksRestrictsTag(tagContentTokens: List<AbstractStacksToken>)
Content copied to clipboard
Link copied to clipboard
fun addStacksReturnsTag(tagContentTokens: List<AbstractStacksToken>)
Content copied to clipboard
Link copied to clipboard
fun addStacksSeesTag(tagContentTokens: List<AbstractStacksToken>)
Content copied to clipboard
Link copied to clipboard
fun addStacksStickyTag(tagContentTokens: List<AbstractStacksToken>)
Content copied to clipboard
Link copied to clipboard
fun addStacksSupertypeTag(tagContentTokens: List<AbstractStacksToken>)
Content copied to clipboard
Link copied to clipboard
fun addStacksTypeTag(tagContentTokens: List<AbstractStacksToken>)
Content copied to clipboard
Link copied to clipboard
fun createStacksComment(): AvailComment?
Content copied to clipboard

Properties

Link copied to clipboard
val moduleName: String
Content copied to clipboard

The name of the module the comment is in.