Module: Chiridion::Engine::DocumentModel

Included in:

SemanticExtractor

Defined in:

lib/chiridion/engine/document_model.rb

Overview

Comprehensive semantic document model for extracted documentation.

This module defines immutable data structures that capture ALL information from YARD and RBS sources. The goal is complete semantic extraction, independent of rendering concerns.

Design principles:

• Capture everything, filter/format at render time

• Prefer explicit nil over missing keys

• Use typed structures (Data.define) for compile-time safety

• Group related data (e.g., yield info together)

See Also:

• for the complete tag inventory this model addresses

Defined Under Namespace

Classes: AttributeDoc, ConstantDoc, ExampleDoc, FileDoc, IvarDoc, MethodDoc, NamespaceDoc, OptionDoc, OverloadDoc, ParamDoc, ProjectDoc, RaiseDoc, ReturnDoc, SeeDoc, TypeAliasDoc, YieldDoc