avail/avail.stacks.comment/CommentBuilder

CommentBuilder

class CommentBuilder

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

Properties

Link copied to clipboard
val moduleName: String

The name of the module the comment is in.

Functions

Link copied to clipboard
fun addStacksAliasTag(tagContentTokens: List<AbstractStacksToken>, fileMap: LinkingFileMap)
Link copied to clipboard
fun addStacksAuthorTag(tagContentTokens: List<AbstractStacksToken>)
Link copied to clipboard
fun addStacksCategoryTag(tagContentTokens: List<AbstractStacksToken>, fileMap: LinkingFileMap)
Link copied to clipboard
Link copied to clipboard
fun addStacksFieldTag(tagContentTokens: List<AbstractStacksToken>)
Link copied to clipboard
fun addStacksForbidTag(tagContentTokens: List<AbstractStacksToken>)
Link copied to clipboard
fun addStacksGlobalTag(tagContentTokens: List<AbstractStacksToken>)
Link copied to clipboard
fun addStacksMacroTag(tagContentTokens: List<AbstractStacksToken>)
Link copied to clipboard
fun addStacksMethodTag(tagContentTokens: List<AbstractStacksToken>)
Link copied to clipboard
fun addStacksModuleTag(tagContentTokens: List<AbstractStacksToken>)
Link copied to clipboard
Link copied to clipboard
fun addStacksRaisesTag(tagContentTokens: List<AbstractStacksToken>)
Link copied to clipboard
Link copied to clipboard
fun addStacksReturnsTag(tagContentTokens: List<AbstractStacksToken>)
Link copied to clipboard
fun addStacksSeesTag(tagContentTokens: List<AbstractStacksToken>)
Link copied to clipboard
fun addStacksStickyTag(tagContentTokens: List<AbstractStacksToken>)
Link copied to clipboard
Link copied to clipboard
fun addStacksTypeTag(tagContentTokens: List<AbstractStacksToken>)
Link copied to clipboard