Skip to content

Commit 663e2f6

Browse files
100% documentation coverage.
1 parent 32c0390 commit 663e2f6

5 files changed

Lines changed: 22 additions & 0 deletions

File tree

lib/decode/rbs.rb

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,9 @@
99
require_relative "rbs/method"
1010
require_relative "rbs/module"
1111
require_relative "rbs/generator"
12+
13+
module Decode
14+
# RBS generation functionality for Ruby type signatures.
15+
module RBS
16+
end
17+
end

lib/decode/rbs/class.rb

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,18 @@
88
require_relative "method"
99
module Decode
1010
module RBS
11+
# Represents a Ruby class definition wrapper for RBS generation.
1112
class Class < Wrapper
1213

14+
# Initialize a new class wrapper.
15+
# @parameter definition [Decode::Definition] The class definition to wrap.
1316
def initialize(definition)
1417
super
1518
@generics = nil
1619
end
1720

21+
# Extract generic type parameters from the class definition.
22+
# @returns [Array] The generic type parameters for this class.
1823
def generics
1924
@generics ||= extract_generics
2025
end

lib/decode/rbs/generator.rb

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,10 @@
1010

1111
module Decode
1212
module RBS
13+
# Represents a generator for RBS type declarations.
1314
class Generator
15+
# Initialize a new RBS generator.
16+
# Sets up the RBS environment for type resolution.
1417
def initialize
1518
# Set up RBS environment for type resolution
1619
@loader = ::RBS::EnvironmentLoader.new()

lib/decode/rbs/method.rb

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,18 @@
1010

1111
module Decode
1212
module RBS
13+
# Represents a Ruby method definition wrapper for RBS generation.
1314
class Method < Wrapper
1415

16+
# Initialize a new method wrapper.
17+
# @parameter definition [Decode::Definition] The method definition to wrap.
1518
def initialize(definition)
1619
super
1720
@signatures = nil
1821
end
1922

23+
# Extract method signatures from the method definition.
24+
# @returns [Array] The extracted signatures for this method.
2025
def signatures
2126
@signatures ||= extract_signatures
2227
end

lib/decode/rbs/module.rb

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,11 @@
88

99
module Decode
1010
module RBS
11+
# Represents a Ruby module definition wrapper for RBS generation.
1112
class Module < Wrapper
1213

14+
# Initialize a new module wrapper.
15+
# @parameter definition [Decode::Definition] The module definition to wrap.
1316
def initialize(definition)
1417
super
1518
end

0 commit comments

Comments
 (0)