X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FTree.pm;h=47e5a5602b209b40c7414868832728e443915313;hb=ab184e4a4303cde87f3f585ec422f99898a915b4;hp=3e8f690066669f5401547001f1368197456216ca;hpb=af9120b08177e0549800dbadc963302d73f1e48f;p=dbsrgits%2FDBIx-Class-Tree.git diff --git a/lib/DBIx/Class/Tree.pm b/lib/DBIx/Class/Tree.pm index 3e8f690..47e5a56 100644 --- a/lib/DBIx/Class/Tree.pm +++ b/lib/DBIx/Class/Tree.pm @@ -4,10 +4,9 @@ package DBIx::Class::Tree; use strict; use warnings; -use vars qw( $VERSION ); use base qw( DBIx::Class ); -$VERSION = '0.01000'; +our $VERSION = '0.03002'; 1; __END__ @@ -16,32 +15,53 @@ __END__ DBIx::Class::Tree - Manipulate and anaylze tree structured data. +=head1 GETTING HELP/SUPPORT + +The community can be found via: + +=over + +=item * IRC: irc.perl.org#dbix-class + +=for html +(click for instant chatroom login) + +=item * Mailing list: L + +=item * RT Bug Tracker: L + +=item * gitweb: L + +=item * git: L + +=back + =head1 DESCRIPTION -The tree modules provide the tools to represent, modify, and analyze +The tree modules provide the tools to represent, modify, and analyze trees of data with DBIx::Class. =head1 COMPONENTS -L - Manage a tree of data using the +L - Manage a tree of data using the common adjacency list model. -L - Glue DBIx::Class::Ordered +L - Glue DBIx::Class::Ordered and DBIx::Class::Tree::AdjacencyList together. =head1 DAG -All tree related modules must conform to have and use the basic traversal -methods of a DAG. For the most part this just means that Tree modules -must provide the appearance of having multiple parents per node (via a -parents() method) but may very well never return more than one parent. -All utility modules, such as a Visitor module, should do its best to -never assume that a node only has one parent. There are situations -where this is not possible - in those cases the module's documentation +All tree related modules must conform to have and use the basic traversal +methods of a DAG. For the most part this just means that Tree modules +must provide the appearance of having multiple parents per node (via a +parents() method) but may very well never return more than one parent. +All utility modules, such as a Visitor module, should do its best to +never assume that a node only has one parent. There are situations +where this is not possible - in those cases the module's documentation should clearly state that it is not compatible with DAGs. -So far there is no Tree::DAG module, but there will be. These requirements -are vague, and the requirements of Tree modules to be DAG compatible will +So far there is no Tree::DAG module, but there will be. These requirements +are vague, and the requirements of Tree modules to be DAG compatible will become more defined in due course. =head1 AUTHOR