Rename group iterator accessors

[chaz/p5-File-KDBX] / lib / File / KDBX / Group.pm

diff --git a/lib/File/KDBX/Group.pm b/lib/File/KDBX/Group.pm
index 1af2c81a3d18b33c7420a9c9c3a1f8c3b3e2e227..9ef603b891c58bc286c0b7e96126f2ae1b15b22e 100644 (file)
--- a/lib/File/KDBX/Group.pm
+++ b/lib/File/KDBX/Group.pm
@@ -121,9 +121,9 @@ sub entries {
     return $entries;
 }
 
-=method entries_deeply
+=method all_entries
 
-    \&iterator = $kdbx->entries_deeply(%options);
+    \&iterator = $kdbx->all_entries(%options);
 
 Get an L<File::KDBX::Iterator> over I<entries> within a group. Supports the same options as L</groups>,
 plus some new ones:
@@ -135,7 +135,7 @@ plus some new ones:
 
 =cut
 
-sub entries_deeply {
+sub all_entries {
     my $self = shift;
     my %args = @_;
 
@@ -143,7 +143,7 @@ sub entries_deeply {
     my $auto_type   = delete $args{auto_type};
     my $history     = delete $args{history};
 
-    my $groups = $self->groups_deeply(%args);
+    my $groups = $self->all_groups(%args);
     my @entries;
 
     return File::KDBX::Iterator->new(sub {
@@ -229,9 +229,9 @@ sub groups {
     return $groups;
 }
 
-=method groups_deeply
+=method all_groups
 
-    \&iterator = $group->groups_deeply(%options);
+    \&iterator = $group->all_groups(%options);
 
 Get an L<File::KDBX::Iterator> over I<groups> within a groups, deeply. Options:
 
@@ -241,7 +241,7 @@ Get an L<File::KDBX::Iterator> over I<groups> within a groups, deeply. Options:
 
 =cut
 
-sub groups_deeply {
+sub all_groups {
     my $self = shift;
     my %args = @_;
 
@@ -328,9 +328,9 @@ sub remove_group {
 
 ##############################################################################
 
-=method objects_deeply
+=method all_objects
 
-    \&iterator = $groups->objects_deeply(%options);
+    \&iterator = $groups->all_objects(%options);
 
 Get an L<File::KDBX::Iterator> over I<objects> within a group, deeply. Groups and entries are considered
 objects, so this is essentially a combination of L</groups> and L</entries>. This won't often be useful, but
@@ -338,7 +338,7 @@ it can be convenient for maintenance tasks. This method takes the same options a
 
 =cut
 
-sub objects_deeply {
+sub all_objects {
     my $self = shift;
     my %args = @_;
 
@@ -346,7 +346,7 @@ sub objects_deeply {
     my $auto_type   = delete $args{auto_type};
     my $history     = delete $args{history};
 
-    my $groups = $self->groups_deeply(%args);
+    my $groups = $self->all_groups(%args);
     my @entries;
 
     return File::KDBX::Iterator->new(sub {
@@ -633,4 +633,7 @@ There is also some metadata associated with a group. Each group in a database is
 a UUID. An entry can also have an icon associated with it, and there are various timestamps. Take a look at
 the attributes to see what's available.
 
+A B<File::KDBX::Group> is a subclass of L<File::KDBX::Object>. View its documentation to see other attributes
+and methods available on groups.
+
 =cut