Overview

• module Decode
  • module Comment

    Represents comment parsing and processing functionality.

    • class Attribute < Tag

      Describes an attribute type.
    • class Constant < Tag

      Represents a constant type declaration.
    • class Example < Tag

      Represents a code example with an optional title.
    • class Node

      Represents a node in a comment tree structure.
    • class Option < Parameter

      Describes a method option (keyword argument).
    • class Parameter < Tag

      Represents a named method parameter.
    • class Pragma < Tag

      Asserts a specific property about the method signature.
    • class Raises < Attribute

      Identifies that a method might raise an exception.
    • class RBS < Tag

      Represents an RBS type annotation following rbs-inline syntax.
    • class Returns < Attribute

      Represents a return value.
    • class Tag < Node

      Represents a documentation tag parsed from a comment directive.
    • class Tags

      Represents a collection of documentation tags and their parsing logic.
    • class Text

      A structured comment.
    • class Throws < Attribute

      Identifies that a method might throw a specific symbol.
    • class Yields < Tag

      Describes a block parameter.
  • class Definition

    A symbol with attached documentation.
  • class Documentation < Comment::Node

    Structured access to a set of comment lines.
  • class Index

    Represents a list of definitions organised for quick lookup and lexical enumeration.
  • module Language

    Language specific parsers and definitions.

    • class Generic

      Represents a generic language implementation that can be extended for specific languages.
    • class Reference

      An reference which can be resolved to zero or more definitions.
    • module Ruby

      Represents an interface for extracting information from Ruby source code.

      • class Alias < Definition

        Represents an alias statement, e.g., alias new_name old_name or alias_method :new_name, :old_name
      • class Attribute < Definition

        A Ruby-specific attribute.
      • class Block < Definition

        A Ruby-specific block which might carry other definitions.
      • class Call < Definition

        A Ruby-specific block which might carry other definitions.
      • class Class < Definition

        A Ruby-specific class.
      • class Singleton < Definition

        A Ruby-specific singleton class.
      • class Code

        A Ruby-specific block of code.
      • class Constant < Definition

        A Ruby-specific constant.
      • class Definition < Decode::Definition

        Represents a Ruby-specific definition extracted from source code.
      • class Function < Method

        A Ruby-specific function.
      • class Generic < Language::Generic

        Represents the Ruby language implementation for parsing and analysis.
      • class Method < Definition

        A Ruby-specific method.
      • class Module < Definition

        A Ruby-specific module.
      • class Parser

        The Ruby source code parser.
      • class Reference < Language::Reference

        An Ruby-specific reference which can be resolved to zero or more definitions.
      • class Segment < Decode::Segment

        A Ruby specific code segment.
  • class Languages

    Represents a context for looking up languages based on file extension or name.
  • class Location

    Represents a location in a source file.
  • module RBS

    RBS generation functionality for Ruby type signatures.

    • class Class < Wrapper

      Represents a Ruby class definition wrapper for RBS generation.
    • class Generator

      Represents a generator for RBS type declarations.
    • class Method < Wrapper

      Represents a Ruby method definition wrapper for RBS generation.
    • class Module < Wrapper

      Represents a Ruby module definition wrapper for RBS generation.
    • module Type

      Utilities for working with RBS types.
    • class Wrapper

      Base wrapper class for RBS generation from definitions.
  • class Scope < Definition

    An abstract namespace for nesting definitions.
  • class Segment

    A chunk of code with an optional preceeding comment block.
  • class Source

    Represents a source file in a specific language.
  • module Syntax

    Provides syntax rewriting and linking functionality.

    • class Link < Match

      Represents a link to a definition in the documentation.
    • class Match

      Represents a match in the source text for syntax rewriting.
    • class Rewriter

      Provides text rewriting functionality with match-based substitutions.
  • class Trie

    Represents a prefix-trie data structure for fast lexical lookups.

    • class Node

      Represents a single node in the trie.