Package avail.stacks.tags

Types

Link copied to clipboard
class StacksAliasTag(aliases: List<QuotedStacksToken>) : StacksTag

An @alias tag for listing Stacks aliases

Link copied to clipboard
class StacksAuthorTag(author: List<AbstractStacksToken>) : StacksTag

he Avail comment "@author" tag

Link copied to clipboard
class StacksCategoryTag(categories: List<QuotedStacksToken>) : StacksTag

The Avail comment "@category" tag

Link copied to clipboard
class StacksCodeTag(codeStyledText: AbstractStacksToken) : StacksTag

The Avail comment "@code" tag. This is used for code like syntax styles.

Link copied to clipboard
class StacksFieldTag(    fieldName: QuotedStacksToken,     fieldType: QuotedStacksToken,     fieldDescription: StacksDescription) : StacksTag

The "@field" tag in an Avail Class comment.

Link copied to clipboard
class StacksForbidsTag(val arityIndex: AbstractStacksToken, val forbidMethods: MutableList<QuotedStacksToken>) : StacksTag

The "@forbids" tag in an Avail Class comment.

Link copied to clipboard
class StacksGlobalTag(globalName: QuotedStacksToken, globalType: QuotedStacksToken) : StacksTag

A global module variable comment tag

Link copied to clipboard
class StacksLinkTag : StacksTag

The "@link" tag use in an Avail comment to link to an external web page.

Link copied to clipboard
class StacksMacroTag(macroName: QuotedStacksToken) : StacksTag

The Avail comment "@macro" tag

Link copied to clipboard
class StacksMethodTag(methodName: QuotedStacksToken) : StacksTag

The Avail comment "@method" tag

Link copied to clipboard
class StacksModuleTag : StacksTag

Construct a new StacksModuleTag.

Link copied to clipboard
class StacksParameterTag(    paramName: QuotedStacksToken,     paramType: QuotedStacksToken,     paramDescription: StacksDescription) : StacksTag

The contents of an Avail comment "@param" tag

Link copied to clipboard
class StacksRaisesTag(exceptionName: QuotedStacksToken, exceptionDescription: StacksDescription) : StacksTag

The "@raises" tag in an Avail comment indicates an exception that is thrown by the method.

Link copied to clipboard
class StacksRestrictsTag(paramMetaType: QuotedStacksToken, description: StacksDescription) : StacksTag

The "@restricts" tag in an Avail comment that represents the meta type of an Avail method's parameter's type as used in a semantic restriction.

Link copied to clipboard
class StacksReturnTag(returnType: RegionStacksToken, returnDescription: StacksDescription) : StacksTag

The "@returns" component of an Avail comment.

Link copied to clipboard
class StacksSeeTag(thingToSee: RegionStacksToken) : StacksTag

The "@see" Avail comment tag.

Link copied to clipboard
class StacksStickyTag : StacksTag

Construct a new StacksStickyTag.

Link copied to clipboard
class StacksSuperTypeTag(superType: QuotedStacksToken) : StacksTag

The "@supertype" keyword of an Avail class comment.

Link copied to clipboard
abstract class StacksTag

An Avail comment @ tag.

Link copied to clipboard
class StacksTypeTag(typeName: QuotedStacksToken) : StacksTag

The Avail comment "@type" tag