[vhffs-dev] [2079] added Vhffs::UserGroup documentation

[subversion@xxxxxxxxxxxxx]

Revision: 2079
Author:   gradator
Date:     2012-02-28 20:30:20 +0100 (Tue, 28 Feb 2012)
Log Message:
-----------
added Vhffs::UserGroup documentation

Modified Paths:
--------------
    trunk/vhffs-api/src/Vhffs/UserGroup.pm

Modified: trunk/vhffs-api/src/Vhffs/UserGroup.pm
===================================================================
--- trunk/vhffs-api/src/Vhffs/UserGroup.pm	2012-02-28 19:20:21 UTC (rev 2078)
+++ trunk/vhffs-api/src/Vhffs/UserGroup.pm	2012-02-28 19:30:20 UTC (rev 2079)
@@ -42,6 +42,28 @@
 
 =pod
 
+=head1 NAME
+
+Vhffs::UserGroup - Vhffs Interface to handle user-group relations
+
+=head1 SYNOPSIS
+
+	use Vhffs::UserGroup;
+	my $vhffs = init Vhffs::Main or die();
+	my $usergroups = Vhffs::UserGroup::getall( $vhffs, Vhffs::Constants::WAITING_FOR_CREATION );
+	foreach ( @{$usergroups} ) {
+		my $user = $usergroup->get_user;
+		my $group = $usergroup->get_group;
+		...
+	}
+=cut
+
+=pod
+=head1 CLASS METHODS
+=cut
+
+=pod
+
 =head2 _new
 
 	Self constructor, almost private, please use getall methods instead.
@@ -98,7 +120,11 @@
 }
 
 =pod
+=head1 INSTANCE METHODS
+=cut
 
+=pod
+
 =head2 get_vhffs
 
 This method returns the Vhffs::Main object.