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

The alias keyword indicates another name for the definition.

Link copied to clipboard

The author keyword indicates the method implementation author.

Link copied to clipboard

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

Link copied to clipboard

The field keyword indicates a field in the class implementation.

Link copied to clipboard

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

Link copied to clipboard

The global keyword represents a module variable

Link copied to clipboard

The method keyword indicates the name of the method implementation.

Link copied to clipboard

The method keyword indicates the name of the method implementation.

Link copied to clipboard

The method keyword indicates the name of the method implementation.

Link copied to clipboard

The parameter keyword indicates an input for the method implementation.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The returns keyword indicates the output for the method implementation.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The supertype keyword indicates the supertype of the class implementation.

Link copied to clipboard

The type keyword indicates the name of the class implementation.

Types

Link copied to clipboard
object Companion

Properties

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