First stab at documenting RakuAST::Type::Subset

Author: lizmat

doc/Type/RakuAST/Type.rakudoc

@@ -17,5 +17,6 @@ They currently are (in alphabetical order):
 =item L<C<RakuAST::Type::Parameterized>|/type/Type/Parameterized>
 =item L<C<RakuAST::Type::Setting>|/type/Type/Setting>
 =item L<C<RakuAST::Type::Simple>|/type/Type/Simple>
+=item L<C<RakuAST::Type::Subset>|/type/Type/Subset>
 
 =end pod

doc/Type/RakuAST/Type/Subset.rakudoc

@@ -0,0 +1,98 @@
+=begin pod :kind("Type") :subkind("class") :category("basic")
+
+=TITLE class RakuAST::Type::Subset
+
+=SUBTITLE Represent a type without any additional features
+
+    class RakuAST::Type::Subset { }
+
+The C<RakuAST::Type::Subset> class represents an C<enum> specification.
+
+=head2 Object introspection
+
+C<RakuAST::Type::Subset> object is typically created when parsing
+Raku Programming Language code.  So most developers will only need to
+know how to introspect the objects created.
+
+=head3 is-coercive
+
+=begin code :preamble<my $subset>
+say $subset.is-coercive;  # True or False
+=end code
+
+The C<is-coercive> method returns whether the "of" type is coercive.
+
+=head3 name
+
+=begin code :preamble<my $subset>
+say $subset.name;  # RakuAST::Name.from-identifier("Foo")
+=end code
+
+Returns the C<L<RakuAST::Name>|/type/RakuAST/Name> object of this
+C<RakuAST::Type::Subset> object.
+
+=head3 of
+
+=begin code :preamble<my $subset>
+say $subset.of;  # RakuAST::Type::Simple.from-identifier("Int")
+=end code
+
+Returns the C<RakuAST::Type>> object of this C<RakuAST::Type::Subset>
+to which the C<enum> B<values> are constrained.
+
+=head3 scope
+
+=begin code :preamble<my $subset>
+say $subset.scope;  # my
+=end code
+
+Returns the scope of the C<RakuAST::Type::Subset> object as a string.
+Usually "our", but can also be "my" or "anon".
+
+=head3 traits
+
+=begin code :preamble<my $subset>
+dd $subset.traits;  # ()
+=end code
+
+Returns a (possibly empty) list of L<C<RakuAST::Trait>|/Type/RakuAST/Trait>
+object that were applied to the C<enum>.
+
+=head3 where
+
+=begin code :preamble<my $subset>
+dd $subset.where;  # * %% 2
+=end code
+
+Returns the L<C<RakuAST::Expression>|/Type/RakuAST/Expression> object
+that represents the names and values of this C<enum>.
+
+=head2 Object creation
+
+There are is only one way to reate a C<RakuAST::Type::Subset> object.
+
+=head3 new
+
+=begin code
+my $subset = RakuAST::Type::Subset.new(
+  scope  => "my",
+  name   => RakuAST::Name.from-identifier('Foo'),
+  of     => RakuAST::Type::Simple.from-identifier('Int'),
+  where  => RakuAST::ApplyInfix.new(
+    left  => RakuAST::Term::Whatever.new,
+    infix => RakuAST::Infix.new('%%'),
+    right => RakuAST::IntLiteral.new(2)
+  ),
+);
+dd $subset;  # my Int subset Foo where * %% 2
+=end code
+
+Creates a C<RakuAST::Type::Subset> object from the given named arguments.
+
+=item scope - string indicating scope (my/our/anon), default: "our"
+=item of - RakuAST::Type object constraining values, default: none
+=item name - RakuAST::Name object with the name of the enum, default: ""
+=item where - RakuAST::Expression to constrain values with, default: none
+=item traits - List of RakuAST::Trait objects, default: none
+
+=end pod