- add docs

git-svn-id: svn+ssh://haiku.zarb.org/home/projects/rpm4/svn/trunk@44 971eb68f-4bfb-0310-8326-d2484c010a4c

1 files changed, 38 insertions, 1 deletions

diff --git a/RPM4/lib/RPM4/Header/Changelogs.pm b/RPM4/lib/RPM4/Header/Changelogs.pm
index be614c0..781a99d 100644
--- a/RPM4/lib/RPM4/Header/Changelogs.pm
+++ b/RPM4/lib/RPM4/Header/Changelogs.pm
@@ -56,7 +56,6 @@ sub time {
     return ${$self->{changelogtime}}[$self->{_counter}];
 }
 
-
 1;
 
 __END__
@@ -65,9 +64,47 @@ __END__
 
 Hdlist::Header::Changelogs - A set of changelogs
 
+=head1 SYNOPSIS
+
+    use RPM4::Header;
+    
+    my $header RPM4::Header->new("foo.rpm");
+    my $changelog = RPM4::Header::Changelog->new($header);
+    $changelog->init; # not need here
+    while ($changelog->hasnext) {
+        print "* ", $changelog->name, "\n";
+        print $changelog->text, "\n";
+    }
+
 =head1 METHODS
 
+=head2 new(header)
+
+Create a new changlelog set object from a rpm header.
+
+=head2 init
+
+Reset internal counter and prepare object for a first L<hasnext> call.
+
+=head2 hasnext
+
+Increase internal counter, return false if last entry has been reached.
+
+=head2 name
+
+Return the CHANGELOGNAME tag of current changelog entry.
+
+=head2 time
+
+Return the CHANGELOGTIME tag of current changelog entry.
+
+=head2 text
+
+Return the CHANGELOGTEXT tag of current changelog entry.
+
 =head1 SEE ALSO
 
+L<RPM4::Header>
+
 L<Hdlist>