PODify the installer

1 files changed, 87 insertions, 0 deletions

diff --git a/perl-install/install/steps_gtk.pm b/perl-install/install/steps_gtk.pm
index a9ef359be..e22f12077 100644
--- a/perl-install/install/steps_gtk.pm
+++ b/perl-install/install/steps_gtk.pm
@@ -25,9 +25,38 @@ use mouse;
 use install::help::help;
 use log;
 
+=head1 SYNOPSYS
+
+Implement a cople specialized graphical installer steps.
+
+=head1 Setup Functions
+
+=over
+
+=cut
+
 #-######################################################################################
 #- In/Out Steps Functions
 #-######################################################################################
+
+
+
+=item new($type, $o)
+
+Initialize the graphical installer:
+
+=over 4
+
+=item * Starts a X.org server
+
+=item * Starts the Spice integration if in a qemu VM
+
+=item * Initialize Gtk+, the theme, and the various used windows
+
+=back
+
+=cut
+
 sub new($$) {
     my ($type, $o) = @_;
 
@@ -66,6 +95,14 @@ sub new($$) {
     $o;
 }
 
+=item _setup_and_start_X($o, $wanted_DISPLAY)
+
+Select the proper X.org server & driver to use (either X.org or Xnest server when running a local test).
+In the former case, it will try first the 'fbdev' driver then the 'vesa' driver if 'fbdev' failed or if the computer uses UEFI.
+
+=cut
+
+
 sub _setup_and_start_X {
     my ($o, $wanted_DISPLAY) = @_;
     my $f = "/tmp/Xconf";
@@ -106,6 +143,12 @@ sub _setup_and_start_X {
     return undef;
 }
 
+=item _launchX($o, $f, $server, $Driver, $wanted_DISPLAY)
+
+Actually starts the selected X.org server using /tmp/Xconf configuration file & logging into /var/log/Xorg.0.log.
+
+=cut
+
 sub _launchX {
     my ($o, $f, $server, $Driver, $wanted_DISPLAY) = @_;
 
@@ -208,6 +251,20 @@ sub interactive_help_get_id {
 #-######################################################################################
 #- Steps Functions
 #-######################################################################################
+
+=back
+
+=head1 Steps Functions
+
+=over
+
+=item selectLanguage($o)
+
+Offer to select language and country.
+This graphical version also warn if RAM is insufficient.
+
+=cut
+
 sub selectLanguage {
     my ($o) = @_;
     $o->SUPER::selectLanguage;
@@ -240,6 +297,12 @@ sub selectMouse {
     } 
 }
 
+=item setPackages($o)
+
+Same as install::any::setPackages($o) but updating the step items.
+
+=cut
+
 sub setPackages {
     my ($o) = @_;
     my (undef, $old_title) = get_default_step_items();
@@ -248,6 +311,13 @@ sub setPackages {
     set_default_step_items($old_title);
 }
 
+
+=item reallyChooseDesktop($o, $title, $message, $choices, $choice)
+
+Dedicated dialog in order to choose the desktop (Plasma, GNOME or custom)
+
+=cut
+
 sub reallyChooseDesktop {
     my ($o, $title, $message, $choices, $choice) = @_;
 
@@ -325,6 +395,12 @@ sub reallyChooseDesktop {
     $choice;
 }
 
+=item reallyChooseGroups($o, $size_to_display, $individual, $_compssUsers)
+
+Dedicated dialog in order to choose the package groups to install or individual package selection.
+
+=cut
+
 sub reallyChooseGroups {
     my ($o, $size_to_display, $individual, $_compssUsers) = @_;
 
@@ -688,6 +764,14 @@ sub installPackages {
     $install_result;
 }
 
+
+=item summary_prompt($o, $l, $check_complete)
+
+Display the summary once the package installation is complete.
+This is the graphical version which overloads the function in L<steps_interactive>.
+
+=cut
+
 sub summary_prompt {
     my ($o, $l, $check_complete) = @_;
 
@@ -805,5 +889,8 @@ It will then continue from the hard disk drive and the packages will remain avai
     log::l("keeping media " . join ',', map { $_->{rpmsdir} } grep { !$_->{ignore} } @$hdlists);
 }
 
+=back
+
+=cut
 
 1;