Changeset 2231 for trunk/LATMOS-Accounts/lib/LATMOS

Timestamp:

03/06/19 09:20:33 (5 years ago)

Author:

nanardon

Message:

Move help from code to POD

File:

• trunk/LATMOS-Accounts/lib/LATMOS/Accounts/Cli/Base.pm (modified) (5 diffs)

trunk/LATMOS-Accounts/lib/LATMOS/Accounts/Cli/Base.pm

@@ -94 +94 @@
         },
     });
-    $self->add_func('quit', { help => 'quit - exit the tool',
+
+=head3 quit
+
+Exit from C<CLI> tools
+
+=cut
+
+    $self->add_func('quit', {
             code => sub { print "\n"; exit(0) }, });
-    $self->add_func('exit', { help => "exit current mode",
+
+=head3 exit
+
+Exit from current selection context
+
+=cut
+
+    $self->add_func('exit', {
             code => sub { return "EXIT" }, });
+
+=head3 !
+
+    ! [command [arg]]
+
+Open a shell command or run command under shell
+
+=cut
+
     $self->add_func('!', {
             code => sub {
@@ -256 +279 @@
     } );
 
-=head2 log
+=head3 log
 
     log [[-o otype ] object [object [...]]]
@@ -299 +322 @@
 
     if ($self->base->can('CreateAlias')) {
+
+=head2 OBJECT ALIASES FUNCTION
+
+=head3 newalias
+
+    newalias objectType Name Object
+
+Create an object alias named C<Name> for object C<Object>.
+
+=cut
+
         $self->add_func(
             'newalias', {
-                help => 'Create an alias object',
                 code => sub {
                     my ($self, $otype, $name, $for) = @_;
@@ -320 +353 @@
             },
         );
+
+=head3 rmalias
+
+    rmalias objectType Name
+
+Delete alias named C<Name>.
+
+=cut
+
         $self->add_func(
             'rmalias', {
-                help => 'Remove an alias object',
                 code => sub {
                     my ($self, $otype, $name) = @_;
@@ -339 +380 @@
             },
         );
+
+=head3 updalias
+
+    updalias objectType Name Object
+
+Change the destination of an existing object alias
+
+=cut
+
         $self->add_func(
             'updalias', {
-                help => 'Update an alias object',
                 code => sub {
                     my ($self, $otype, $name, $for) = @_;