[gimp-perl] Doc update.



commit 61180a63b2810982d84141381b6e5af9cf072c74
Author: Ed J <edj src gnome org>
Date:   Tue May 13 05:41:18 2014 +0100

    Doc update.

 examples/example-extension       |   17 +++++++++++++----
 examples/example-extension-no-fu |   35 ++++++++++++++++++++++++++++++++++-
 2 files changed, 47 insertions(+), 5 deletions(-)
---
diff --git a/examples/example-extension b/examples/example-extension
index 3bd4ef8..4bcd0c6 100755
--- a/examples/example-extension
+++ b/examples/example-extension
@@ -6,7 +6,7 @@ use Gimp::Extension;
 
 #$Gimp::verbose = 1;
 #Gimp::set_trace(TRACE_ALL);
-my $persist = 6;
+my $persist;
 
 register_temp
   'extension_test_temp',
@@ -24,7 +24,7 @@ register_temp
     $persist;
   };
 
-podregister { Gtk2->main; };
+podregister { $persist = $_[1]; Gtk2->main; };
 
 exit main;
 __END__
@@ -39,12 +39,21 @@ extension_test - test Gimp::Extension
 
 =head1 DESCRIPTION
 
-Description.
+Installs a temporary procedure, C<extension_test_temp>. This takes args
+of C<$run_mode, $number>, adds the number to the extension's persistent
+data number, and returns its new value.
+
+The extension itself's C<num> parameter is the initial value of the
+persistent storage number, if given. The number does not persist across
+runs of GIMP.
+
+See L<examples/example-extension-tester> for a small L<Gimp::Fu> plugin
+that exercises this extension.
 
 =head1 PARAMETERS
 
  [&Gimp::PDB_INT32, "run_mode", "Interactive:0=yes,1=no"],
- [&Gimp::PDB_INT32, "num", "internal flags (must be 0)"],
+ [&Gimp::PDB_INT32, "num", "Initial number value"],
 
 =head1 RETURN VALUES
 
diff --git a/examples/example-extension-no-fu b/examples/example-extension-no-fu
index dbd3433..5301ff5 100755
--- a/examples/example-extension-no-fu
+++ b/examples/example-extension-no-fu
@@ -1,4 +1,4 @@
-#!/usr/local/bin/perl -w
+#!/usr/bin/perl -w
 
 BEGIN { $Gimp::verbose = 1; }
 use Gimp;
@@ -49,3 +49,36 @@ Gimp::on_query {
 };
 
 exit Gimp::main;
+__END__
+
+=head1 NAME
+
+extension_gp_test - Demo Gimp::Extension
+
+=head1 SYNOPSIS
+
+<None>
+
+=head1 DESCRIPTION
+
+Example extension that does not use L<Gimp::Extension>.
+
+=head1 PARAMETERS
+
+ # none
+
+=head1 RETURN VALUES
+
+ # none
+
+=head1 AUTHOR
+
+Ed J
+
+=head1 DATE
+
+2014-05-03
+
+=head1 LICENSE
+
+Same terms as Gimp-Perl.


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]