[Dbix-class] Documentation of DBIx::Class schemas

[Brett Gardner]

I just use POD.

I list all the fields, and all the relationships and then POD all 
methods as well.

eg in the schema

...
=pod

=head1 RELATIONSHIPS

=over 4

=item B<module>

This is a L<MyApp::Schema::Module> that ...

=cut
__PACKAGE__->belongs_to('module'=>'MyApp::Schema::Module'...)

... (more relationships) ...

=pod

=back 4

=cut

Pedro Melo wrote:
> Hi,
>
> I was wondering how do you document your schemas?
>
> I started adding 'docs' keys to the extra hash for each column. I've 
> also added a Doc component that allows me to set up some texts as 
> documentation for the class.
>
> Then I can use basic introspection and generate the entire 
> documentation (right now using a Catalyst::Controller).
>
> To prevent unnecessary memory usage in production, all the text of the 
> docs is not kept unless a environment variable is set.
>
> I wonder what other people is doing....
>
> Best regards,