[maven-debian-helper] 01/05: Javadoc for GetPackageResult

[Emmanuel Bourg]

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

ebourg-guest pushed a commit to branch master
in repository maven-debian-helper.

commit c2dd1bb375d6751361fc074ac12cc44373438ab0
Author: Emmanuel Bourg <ebourg at apache.org>
Date:   Mon Aug 26 08:44:56 2013 +0200

    Javadoc for GetPackageResult
---
 .../java/org/debian/maven/packager/util/GetPackageResult.java |    9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/maven-packager-utils/src/main/java/org/debian/maven/packager/util/GetPackageResult.java b/maven-packager-utils/src/main/java/org/debian/maven/packager/util/GetPackageResult.java
index 076122a..3f6f611 100644
--- a/maven-packager-utils/src/main/java/org/debian/maven/packager/util/GetPackageResult.java
+++ b/maven-packager-utils/src/main/java/org/debian/maven/packager/util/GetPackageResult.java
@@ -19,6 +19,15 @@ package org.debian.maven.packager.util;
 import java.util.Set;
 import java.util.TreeSet;
 
+/**
+ * Parses the output of the <tt>dpkg --search</tt> and <tt>apt-file find</tt>
+ * commands and extracts the name of the packages matching the search criteria.
+ * <p>
+ * The format expected is:
+ * <pre>
+ *     <pkg>: <file>
+ * </pre>
+ */
 public class GetPackageResult implements OutputHandler {
 
     private final Set<String> result = new TreeSet<String>();

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-java/maven-debian-helper.git