module Comment

Represents comment parsing and processing functionality.

Nested Classes and Modules

class Attribute

Describes an attribute type.

class Constant

Represents a constant type declaration.

class Example

Represents a code example with an optional title.

class Node

Represents a node in a comment tree structure.

class Option

Describes a method option (keyword argument).

class Parameter

Represents a named method parameter.

class Pragma

Asserts a specific property about the method signature.

class Raises

Identifies that a method might raise an exception.

class RBS

Represents an RBS type annotation following rbs-inline syntax.

class Returns

Represents a return value.

class Tag

Represents a documentation tag parsed from a comment directive. Subclasses should define a PATTERN constant for matching their specific syntax.

class Tags

Represents a collection of documentation tags and their parsing logic.

class Text

A structured comment.

class Throws

Identifies that a method might throw a specific symbol.

class Yields

Describes a block parameter.