[Reproducible-commits] [dpkg] 22/33: Dpkg::Changelog::Entry::Debian: Document all public methods

[Mattia Rizzolo]

This is an automated email from the git hooks/post-receive script.

mattia pushed a commit to branch master
in repository dpkg.

commit 048f56f78cd7886c1835343ff97b68679a6f7aa6
Author: Guillem Jover <guillem at debian.org>
Date:   Fri Jul 29 21:17:58 2016 +0200

    Dpkg::Changelog::Entry::Debian: Document all public methods
---
 debian/changelog                       |  1 +
 scripts/Dpkg/Changelog/Entry/Debian.pm | 49 ++++++++++++++++++++++++++++++++++
 2 files changed, 50 insertions(+)

diff --git a/debian/changelog b/debian/changelog
index 191e827..c5fafdd 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -27,6 +27,7 @@ dpkg (1.18.10) UNRELEASED; urgency=medium
       Reported by Mattia Rizzolo <mattia at debian.org>.
     - Remove mention of source format 1.0 supporting building with upstream
       tarball signatures from dpkg-source(1), as this was disabled in 1.18.8.
+    - Document all public methods in Dpkg::Changelog::Entry::Debian.
 
   [ Updated programs translations ]
   * German (Sven Joachim).
diff --git a/scripts/Dpkg/Changelog/Entry/Debian.pm b/scripts/Dpkg/Changelog/Entry/Debian.pm
index 83542e7..30f857b 100644
--- a/scripts/Dpkg/Changelog/Entry/Debian.pm
+++ b/scripts/Dpkg/Changelog/Entry/Debian.pm
@@ -284,18 +284,36 @@ sub normalize {
     #XXX: recreate header/trailer
 }
 
+=item $src = $entry->get_source()
+
+Return the name of the source package associated to the changelog entry.
+
+=cut
+
 sub get_source {
     my $self = shift;
 
     return $self->{header_source};
 }
 
+=item $ver = $entry->get_version()
+
+Return the version associated to the changelog entry.
+
+=cut
+
 sub get_version {
     my $self = shift;
 
     return $self->{header_version};
 }
 
+=item @dists = $entry->get_distributions()
+
+Return a list of target distributions for this version.
+
+=cut
+
 sub get_distributions {
     my $self = shift;
 
@@ -306,6 +324,13 @@ sub get_distributions {
     return;
 }
 
+=item $fields = $entry->get_optional_fields()
+
+Return a set of optional fields exposed by the changelog entry.
+It always returns a Dpkg::Control object (possibly empty though).
+
+=cut
+
 sub get_optional_fields {
     my $self = shift;
     my $f;
@@ -324,6 +349,12 @@ sub get_optional_fields {
     return $f;
 }
 
+=item $urgency = $entry->get_urgency()
+
+Return the urgency of the associated upload.
+
+=cut
+
 sub get_urgency {
     my $self = shift;
     my $f = $self->get_optional_fields();
@@ -334,18 +365,36 @@ sub get_urgency {
     return;
 }
 
+=item $maint = $entry->get_maintainer()
+
+Return the string identifying the person who signed this changelog entry.
+
+=cut
+
 sub get_maintainer {
     my $self = shift;
 
     return $self->{trailer_maintainer};
 }
 
+=item $time = $entry->get_timestamp()
+
+Return the timestamp of the changelog entry.
+
+=cut
+
 sub get_timestamp {
     my $self = shift;
 
     return $self->{trailer_timestamp_date};
 }
 
+=item $time = $entry->get_timepiece()
+
+Return the timestamp of the changelog entry as a Time::Piece object.
+
+=cut
+
 sub get_timepiece {
     my $self = shift;
 

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/reproducible/dpkg.git