From: Marcus Ramberg <mramberg@cpan.org>
Date: Thu, 11 Aug 2005 22:39:16 +0000 (+0000)
Subject: improved docs.
X-Git-Tag: v0.03001~42
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=15fe6346d3458b5127c743409c5407e0dbc3931b;p=dbsrgits%2FDBIx-Class.git

improved docs.
---

diff --git a/lib/DBIx/Class/CDBICompat.pm b/lib/DBIx/Class/CDBICompat.pm
index 30e3b58..08bc7c9 100644
--- a/lib/DBIx/Class/CDBICompat.pm
+++ b/lib/DBIx/Class/CDBICompat.pm
@@ -33,10 +33,95 @@ __PACKAGE__->load_own_components(qw/
 
 DBIx::Class::CDBICompat - Class::DBI Compatability layer.
 
+=head1 SYNOPSIS
+
+  use base qw/DBIx::Class/;
+  __PACKAGE__->load_components(qw/CDBICompat Core DB/);
+
 =head1 DESCRIPTION
 
-This class just inherits from the various modules that makes 
-up the Class::DBI compability layer.
+DBIx::Class features a fully featured compability layer with L<Class::DBI>
+to ease transition for existing CDBI users. In fact, this class is just a
+receipe containing all the features emulated. If you like, you can choose
+which features to emulate by building your own class and loading it like 
+this:
+
+  __PACKAGE__->load_own_components(qw/CDBICompat/);
+
+this will automatically load the features included in My::DB::CDBICompat, 
+provided it looks something like this:
+
+  package My::DB::CDBICompat;
+  __PACKAGE__->load_components(qw/
+    CDBICompat::ColumnGroups
+    CDBICompat::Retrieve
+    CDBICompat::HasA
+    CDBICompat::HasMany
+    CDBICompat::MightHave
+  /);
+
+=head1 Components
+
+=over 4
+
+=item AccessorMapping
+
+=item AttributeAPI
+
+=item AutoUpdate
+
+Allows you to turn on automatic updates for column values.
+
+=item ColumnCase
+
+=item ColumnGroups
+
+=item Constraints
+
+=item Constructor
+
+=item DestroyWarning
+
+=item GetSet
+
+=item HasA
+
+Responsible for HasA relationships. 
+
+=item HasMany
+
+Responsible for HasMany relationships. 
+
+=item ImaDBI
+
+=item LazyLoading
+
+=item LiveObjectIndex
+
+The live object index tries to ensure there is only one version of a object
+in the perl interprenter.
+
+=item MightHave
+
+Responsible for MightHave relationships. 
+
+=item ObjIndexStubs
+
+=item ReadOnly
+
+=item Retrieve
+
+=item Stringify
+
+=item TempColumns
+
+=item Triggers
+
+This class implements the trigger functionality.
+
+=item PassThrough
+
+=back
 
 
 =head1 AUTHORS