Package avail.
Types
Link copied to clipboard
An abstract Avail comment.
Link copied to clipboard
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.
Link copied to clipboard
A builder class for an AvailComment.
Link copied to clipboard
class GlobalComment( signature: CommentSignature, commentStartLine: Int, author: List<StacksAuthorTag>, sees: List<StacksSeeTag>, description: StacksDescription, categories: List<StacksCategoryTag>, aliases: List<StacksAliasTag>, globalTag: StacksGlobalTag) : AvailComment
Content copied to clipboard
A module global variable comment
Link copied to clipboard
class GrammaticalRestrictionComment( signature: CommentSignature, commentStartLine: Int, author: List<StacksAuthorTag>, sees: List<StacksSeeTag>, description: StacksDescription, categories: List<StacksCategoryTag>, aliases: List<StacksAliasTag>, forbids: MutableMap<Int, StacksForbidsTag>) : AvailComment
Content copied to clipboard
A comment implementation of grammatical restrictions
Link copied to clipboard
class MacroComment( signature: MethodCommentSignature, commentStartLine: Int, author: List<StacksAuthorTag>, sees: List<StacksSeeTag>, description: StacksDescription, categories: List<StacksCategoryTag>, aliases: List<StacksAliasTag>, parameters: List<StacksParameterTag>, returnsContent: StacksReturnTag, val exceptions: List<StacksRaisesTag>, sticky: Boolean) : AvailComment
Content copied to clipboard
A comment that describes a particular macro implementation
Link copied to clipboard
class MethodComment( signature: MethodCommentSignature, commentStartLine: Int, author: MutableList<StacksAuthorTag>, sees: MutableList<StacksSeeTag>, description: StacksDescription, categories: MutableList<StacksCategoryTag>, aliases: MutableList<StacksAliasTag>, parameters: MutableList<StacksParameterTag>, val returnsContent: StacksReturnTag, exceptions: MutableList<StacksRaisesTag>, sticky: Boolean) : AvailComment
Content copied to clipboard
A comment that describes a particular method implementation
Link copied to clipboard
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
Link copied to clipboard
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