From 929de006150b55af21f38ee3ade50ad9a85fa8e6 Mon Sep 17 00:00:00 2001
From: "Thierry.Vignaud" <thierry.vignaud@gmail.com>
Date: Mon, 26 May 2014 17:23:24 +0200
Subject: convert comments to POD

---
 perl-install/NEWS         |  1 +
 perl-install/do_pkgs.pm   | 47 ++++++++++++++++++++++++++++++++++++++++++-----
 perl-install/install/NEWS |  1 +
 3 files changed, 44 insertions(+), 5 deletions(-)

(limited to 'perl-install')

diff --git a/perl-install/NEWS b/perl-install/NEWS
index 64c4092d5..877393b4f 100644
--- a/perl-install/NEWS
+++ b/perl-install/NEWS
@@ -1,3 +1,4 @@
+- add some POD documentation
 - fix detecting some UPS devices (mga#13424)
 
 Version 16.28 - 28 April 2014
diff --git a/perl-install/do_pkgs.pm b/perl-install/do_pkgs.pm
index cfc244711..c5712111f 100644
--- a/perl-install/do_pkgs.pm
+++ b/perl-install/do_pkgs.pm
@@ -1,5 +1,23 @@
 package do_pkgs; # $Id: do_pkgs.pm 263860 2009-11-30 15:20:14Z blino $
 
+=head1 SYNOPSYS
+
+B<do_pkgs> enables to install packages (through urpmi) from our tools.
+It works both during installer and in standalone tools.
+
+
+=head1 Functions
+
+=over
+
+=cut
+
+=item do_pkgs($in)
+
+Returns a new B<do_pkgs> object from a L<interactive> object.
+
+=cut
+
 sub do_pkgs {
     my ($in) = @_;
     ($::isInstall ? 'do_pkgs_during_install' : 'do_pkgs_standalone')->new($in);
@@ -68,7 +86,12 @@ sub ensure_binary_is_installed {
     1;
 }
 
-# takes a list of [ "package", "file" ] and installs package if file is not there
+=item ensure_files_are_installed($do, $pkgs, $b_auto)
+
+Takes a list of [ "package", "file" ] and installs package if file is not there.
+
+=cut
+
 sub ensure_files_are_installed {
     my ($do, $pkgs, $b_auto) = @_;
 
@@ -108,10 +131,20 @@ sub is_installed {
     $do->are_installed($name);
 }
 
-#- takes something like "ati-kernel"
-#- returns:
-#- - the various ati-kernel-2.6.XX-XXmdk available for the installed kernels
-#- - dkms-ati if available
+=item check_kernel_module_packages($do, $base_name)
+
+Takes something like "C<ati-kernel>" and returns:
+
+=over 4
+
+=item * the various C<ati-kernel-2.6.XX-XXmdk> available for the installed kernels
+
+=item * C<dkms-ati> if available
+
+=back
+
+=cut
+
 sub check_kernel_module_packages {
     my ($do, $base_name) = @_;
     
@@ -296,3 +329,7 @@ sub remove_nodeps {
     my ($do, @l) = @_;
     remove($do, '--nodeps', @l) == 0;
 }
+
+=back
+
+=cut
diff --git a/perl-install/install/NEWS b/perl-install/install/NEWS
index 73130b61c..60ee77fe9 100644
--- a/perl-install/install/NEWS
+++ b/perl-install/install/NEWS
@@ -1,3 +1,4 @@
+- add some POD documentation
 - do not unavailable kernel-xbox
 
 Version 16.29 -  3 May 2014
-- 
cgit v1.2.1