StacksTagKeyword

enum StacksTagKeyword : Enum<StacksParser.StacksTagKeyword>

The collection of section keywords that a comment can have.

Author

Richard Arriaga

Parameters

lexeme

String representation of the keyword.

Entries

Link copied to clipboard
TYPE("@type")

The type keyword indicates the name of the class implementation.

Link copied to clipboard
SUPERTYPE("@supertype")

The supertype keyword indicates the supertype of the class implementation.

Link copied to clipboard
STICKY("@sticky")

The sticky keyword indicates the method/macro/class should be documented regardless of visibility.

Link copied to clipboard
SEE("@see")

The see keyword refers the reader to something else. Not inherently linked.

Link copied to clipboard
RETURNS("@returns")

The returns keyword indicates the output for the method implementation.

Link copied to clipboard
RESTRICTS("@restricts")

The restricts keyword indicates the input types used by the method implementation's semantic restriction.

Link copied to clipboard
RAISES("@raises")

The raises keyword indicates the exceptions thrown by the method implementation.

Link copied to clipboard
PARAMETER("@param")

The parameter keyword indicates an input for the method implementation.

Link copied to clipboard
MODULE("@module")

The method keyword indicates the name of the method implementation.

Link copied to clipboard
METHOD("@method")

The method keyword indicates the name of the method implementation.

Link copied to clipboard
MACRO("@macro")

The method keyword indicates the name of the method implementation.

Link copied to clipboard
GLOBAL("@global")

The global keyword represents a module variable

Link copied to clipboard
FORBIDS("@forbids")

The forbids keyword indicates the methods forbidden by a Grammatical Restriction for the method implementation.

Link copied to clipboard
FIELD("@field")

The field keyword indicates a field in the class implementation.

Link copied to clipboard
CATEGORY("@category")

The category keyword provides a category to which the method implementation belongs.

Link copied to clipboard
AUTHOR("@author")

The author keyword indicates the method implementation author.

Link copied to clipboard
ALIAS("@alias")

The alias keyword indicates another name for the definition.

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val name: String
Link copied to clipboard
val ordinal: Int