codoc 0.1.0

Unified documentation parser for Ruby and TypeScript codebases
Documentation
# frozen_string_literal: true

# The root module for the application.
#
# This module contains all core functionality.
module Application
  # The version of the application.
  VERSION = "1.0.0"

  # Default configuration options.
  DEFAULTS = {
    timeout: 30,
    retries: 3
  }.freeze

  # A nested module for utilities.
  #
  # Contains helper methods and utilities.
  module Utils
    # Formats a string for display.
    #
    # @param value [String] the value to format
    # @param uppercase [Boolean] whether to uppercase
    # @return [String] the formatted string
    def self.format(value, uppercase: false)
      uppercase ? value.upcase : value
    end
  end

  # A deeply nested class.
  #
  # Demonstrates namespace handling.
  class Core
    # The core configuration.
    #
    # @return [Hash]
    attr_reader :config

    # Initializes with configuration.
    #
    # @param config [Hash] the configuration hash
    def initialize(config = {})
      @config = config
    end
  end
end