sober_swag 0.19.0 → 0.20.0

data/lib/sober_swag/type/named.rb

@@ -9,24 +9,38 @@ module SoberSwag
       # Modules that include {SoberSwag::Type::Named}
       # will automatically extend this module.
       module ClassMethods
+        ##
+        # Is this type a "wrapper" for another type?
         def alias?
           false
         end
 
+        ##
+        # The type this type is a wrapper for
         def alias_of
           nil
         end
 
+        ##
+        # The "root" type along the alias chain
         def root_alias
           alias_of || self
         end
 
+        ##
+        # @overload description()
+        #   @return [String] a human-readable description of this type
+        # @overload description(arg)
+        #   @param arg [String] a human-readable description of this type
+        #   @return [String] `arg`
         def description(arg = nil)
           @description = arg if arg
           @description
         end
       end
 
+      ##
+      # When included, extends {SoberSwag::Type::Named::ClassMethods}
       def self.included(mod)
         mod.extend(ClassMethods)
       end

data/lib/sober_swag/types/comma_array.rb

@@ -3,6 +3,10 @@ module SoberSwag
     ##
     # An array that will be parsed from comma-separated values in a string, if given a string.
     module CommaArray
+      ##
+      # Get a parser that will parse comma-separated values of another type.
+      # @param other [Class] a swagger-able type to parse into
+      # @return [SoberSwag::Types::CommaArray]
       def self.of(other)
         SoberSwag::Types::Array.of(other).constructor { |val|
           if val.is_a?(::String)

data/lib/sober_swag/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SoberSwag
-  VERSION = '0.19.0'
+  VERSION = '0.20.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sober_swag
 version: !ruby/object:Gem::Version
-  version: 0.19.0
+  version: 0.20.0
 platform: ruby
 authors:
 - Anthony Super
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-10 00:00:00.000000000 Z
+date: 2021-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -180,6 +180,7 @@ files:
 - ".rubocop.yml"
 - ".ruby-version"
 - ".travis.yml"
+- ".yardopts"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt