Skip to content

Commit

Permalink
Merge pull request #83 from JJ/master
Browse files Browse the repository at this point in the history
new TODO and some changes in documentation
  • Loading branch information
antoniogamiz authored Aug 6, 2019
2 parents 1ccec64 + 8981257 commit ab7a13f
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 5 deletions.
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -76,4 +76,6 @@ package-lock.json
app.pl
app-start
Makefile
.cache-*
.cache-*
.t

6 changes: 6 additions & 0 deletions TODO.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# To do some issues

* [ ] In multi-class files, can we add metadata to `=begin pod` in the same way we did before?

* [ ] Are generated elements cached? Can you add stuff to the cache?

8 changes: 4 additions & 4 deletions docs/reference/perl6-documentable.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## enum Kind
## `enum` Kind

Each and every one of the things documented has a `kind` value. This value can tell you "where that documented piece" comes from. There are six different possible values:

Expand All @@ -9,13 +9,13 @@ Each and every one of the things documented has a `kind` value. This value can t
| Programs | Complete pod from Programs dir |
| Syntax | Pod fragment from a complete pod |
| Routine | Pod fragment from a complete pod |
| Reference | X<> element |
| Reference | Element generated via X<> |

See `Perl6::Documentable::Heading::*` to see when `Syntax` or `Routine` is assigned.
See `Perl6::Documentable::Heading::*` to understand when `Syntax` or `Routine` is assigned.

## class Perl6::Documentable

`Perl6::Documentable` represents a piece of Perl 6 that is documented.
`Perl6::Documentable` represents a self-contained Perl 6 documentation element.

This class is the base for `Perl6::Documentable::File` and `Perl6::Documentable::Derived`. You should use both of them instead, since this one only represents what every documented piece must have.

Expand Down

0 comments on commit ab7a13f

Please sign in to comment.