Arthur Axel "fREW" Schmidt > DBIx-Class-0.08203 > DBIx::Class::Manual::Reading

Download:
DBIx-Class-0.08203.tar.gz

Annotate this POD

Website

CPAN RT

New  12
Open  18
Stalled  11
View/Report Bugs
Source   Latest Release: DBIx-Class-0.082810

NAME ^

DBIx::Class::Manual::Reading - How to read and write DBIx::Class POD.

DESCRIPTION ^

This doc should help users to understand how the examples and documentation found in the DBIx::Class distribution can be interpreted.

Writers of DBIx::Class POD should also check here to make sure their additions are consistent with the rest of the documentation.

METHODS ^

Methods should be documented in the files which also contain the code for the method, or that file should be hidden from PAUSE completely, in which case the methods are documented in the file which loads it. Methods may also be documented and referred to in files representing the major objects or components on which they can be called.

For example, DBIx::Class::Relationship documents the methods actually coded in the helper relationship classes like DBIx::Class::Relationship::BelongsTo. The BelongsTo file itself is hidden from PAUSE as it has no documentation. The accessors created by relationships should be mentioned in DBIx::Class::Row, the major object that they will be called on.

Method documentation

AUTHORS ^

see DBIx::Class

LICENSE ^

You may distribute this code under the same terms as Perl itself.

syntax highlighting: