If you want to automate some documentation features with regards to
inheritance and role composition, you can use these two modules:
https://metacpan.org/module/Pod::Weaver::Section::Extends
https://metacpan.org/module/Pod::Weaver::Section::Consumes
Mike
On Tue, Dec 18, 2012 at 2:52 PM, Maurice
Thanks for quick replies! Lot's of good stuff.
Personally, I am not a fan of documenting anything twice, so I don't like
to document inherited stuff in the inheriting class, but I have seen
modules that seem to create documentation automatically. That might work
(in many cases), especially if you
On Tue, 18 Dec 2012 09:37:36 -0700
Maurice Mengel wrote:
> Hi!
>
> I am new to the list and also still new to Moose. I wonder how
> exactly to document my Moose classes. I am sure you discussed this
> before, but I couldn't find much on the list archive. Perhaps it's
> time to add something on t
Maurice,
> It seems some people like inherited stuff
> (including roles) to be listed in each class that inherits stuff and others
> like it only in the class which defines stuff.
It seems to me that the problem with listing methods (and/or
attributes) that you inherit is that, if the base class
I add another level under the attributes and methods to differentiate public
and private.
I also add another section in there for Roles.
In my Roles, I make sure if there are required methods, that I document what
the expected api is supposed to be.
=head2 REQUIRES
=cut
requires qw(method
