xlsxrb 0.1.6 → 0.1.7

data/sig/generated/xlsxrb/elements/cell.rbs

@@ -3,7 +3,16 @@
 module Xlsxrb
   module Elements
     # Represents a single cell in a worksheet.
-    # All indices are 0-based.
+    # All row and column indices are 0-based.
+    #
+    # @example Access cell properties
+    #   cell = sheet["A1"]
+    #   cell.value       # raw value
+    #   cell.ref         # "A1"
+    #   cell.to_i        # integer value
+    #   cell.to_date     # Date value
+    #
+    # @api public
     class Cell < Data
       attr_reader row_index(): untyped
 

data/sig/generated/xlsxrb/elements/column.rbs

@@ -4,6 +4,11 @@ module Xlsxrb
   module Elements
     # Represents column formatting in a worksheet.
     # index is 0-based.
+    #
+    # @example
+    #   col = Elements::Column.new(index: 0, width: 25.0)
+    #
+    # @api public
     class Column < Data
       attr_reader index(): untyped
 

data/sig/generated/xlsxrb/elements/row.rbs

@@ -3,7 +3,14 @@
 module Xlsxrb
   module Elements
     # Represents a single row in a worksheet.
-    # index is 0-based.
+    # All row and column indices are 0-based.
+    #
+    # @example Access cell by index or symbol
+    #   row = sheet.row_at(0)
+    #   cell = row[0]       # cell at column 0
+    #   row.to_a            # array of cell values
+    #
+    # @api public
     class Row < Data
       attr_reader index(): untyped
 

data/sig/generated/xlsxrb/elements/types.rbs

@@ -8,8 +8,12 @@ module Xlsxrb
 
     EMPTY_CELLS: untyped
 
-    # Represents a formula with an optional cached value.
-    # Optional: type (:shared, :array), ref (range), shared_index (si for shared formulas)
+    # Represents an Excel formula with an optional cached value and calculation properties.
+    #
+    # @example Create a formula
+    #   formula = Elements::Formula.new(expression: "SUM(A1:A10)")
+    #
+    # @api public
     class Formula < Data
       attr_reader expression(): untyped
 
@@ -44,6 +48,7 @@ module Xlsxrb
     end
 
     # Represents a cell error value (e.g. #N/A, #REF!, #DIV/0!).
+    # @api public
     VALID_ERROR_CODES: untyped
 
     class CellError < Data
@@ -57,9 +62,12 @@ module Xlsxrb
       def members: () -> [ :code ]
     end
 
-    # Represents a rich text string with formatting runs.
-    # runs: array of hashes, each with :text and optional :font (hash of font properties).
-    # Font properties: :bold, :italic, :underline, :sz, :color, :name
+    # Represents a rich text string with multiple formatting runs.
+    #
+    # @example
+    #   rt = Elements::RichText.new(runs: [{ text: "Hello ", font: { bold: true } }, { text: "World" }])
+    #
+    # @api public
     class RichText < Data
       attr_reader runs(): untyped
 

data/sig/generated/xlsxrb/elements/workbook.rbs

@@ -2,7 +2,14 @@
 
 module Xlsxrb
   module Elements
-    # Represents an entire XLSX workbook.
+    # Represents an entire in-memory XLSX workbook.
+    #
+    # @example Access sheets
+    #   workbook = Xlsxrb.read("report.xlsx")
+    #   sheet = workbook.sheet(0) # or workbook["Sheet1"]
+    #   workbook.each { |s| puts s.name }
+    #
+    # @api public
     class Workbook < Data
       attr_reader sheets(): untyped
 

data/sig/generated/xlsxrb/elements/worksheet.rbs

@@ -3,6 +3,13 @@
 module Xlsxrb
   module Elements
     # Represents a single worksheet in a workbook.
+    #
+    # @example Access cells and rows
+    #   sheet = workbook.sheet(0)
+    #   cell = sheet["A1"]
+    #   sheet.each_row { |row| puts row.to_a.inspect }
+    #
+    # @api public
     class Worksheet < Data
       attr_reader name(): untyped