Explain Perl6::Documentable a bit

Raku · Mar 23, 2019 · 44c8eda · 44c8eda
1 parent c3b6cb8
commit 44c8eda
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/lib/Perl6/Documentable.pm6 b/lib/Perl6/Documentable.pm6
@@ -1,5 +1,10 @@
 use URI::Escape;
 class Perl6::Documentable {
+    # Perl6::Documentable Represents a piece of Perl 6 that is documented.
+    # It contains meta data about what is documented
+    # (for example (kind => 'type', subkinds => ['class'], name => 'Code')
+    # and in $.pod a reference to the actual documentation.
+
     has Str $.kind;        # type, language doc, routine, module
     has Bool $.section;     # for Language doc list breakdown by sections
     has Str @.subkinds;    # class/role/enum, sub/method, prefix/infix/...