qulogic/gplugin

I forgot to commit perl.xml
develop
2020-02-21, Gary Kramlich
a6f4784afe0b
Parents a37626fc06a2
Children 70cb1c992a08d6afbe11cdc1549028d5be9d207a4982ca7887b2d20bb128
I forgot to commit perl.xml
1 files changed, 60 insertions(+), 0 deletions(-)
  • +60 -0
    gplugin/reference/perl.xml
    • --- /dev/null Thu Jan 01 00:00:00 1970 +0000
    +++ b/gplugin/reference/perl.xml Fri Feb 21 00:11:31 2020 -0600
    @@ -0,0 +1,60 @@
    +<?xml version='1.0' encoding="UTF-8"?>
    +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
    + "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
    +]>
    +<chapter id="chapter-perl">
    + <title>Perl Plugins</title>
    +
    + <warning>
    + <para>
    + You <emphasis role="strong">MUST</emphasis> have the Perl loader
    + plugin installed and working as well as the gobject-introspection
    + package for GPlugin installed to use Perl plugins.
    + </para>
    + </warning>
    +
    + <simplesect>
    + <title>Example Perl Plugin</title>
    +
    + <para>
    + Like all plugins in GPlugin, Perl plugins must also implement
    + the <code>gplugin_query</code>, <code>gplugin_load</code>, and
    + <code>gplugin_unload</code> functions.
    + </para>
    +
    + <para>
    + The following is a basic Perl plugin.
    + </para>
    +
    + <informalexample><programlisting>
    + use strict;
    +
    + use Glib::Object::Introspection;
    +
    + Glib::Object::Introspection->setup(basename => "GPlugin", version => "0.0", package=> "GPlugin");
    +
    + sub gplugin_query {
    + return GPlugin::PluginInfo->new(
    + id => "gplugin/perl-basic-plugin",
    + abi_version => 0x01020304,
    + name => "basic plugin",
    + authors => ("author1"),
    + category => "test",
    + version => "version",
    + license_id => "license",
    + summary => "summary",
    + website => "website",
    + description => "description",
    + );
    + }
    +
    + sub gplugin_load {
    + return 0;
    + }
    +
    + sub gplugin_unload {
    + return 0;
    + }
    + </programlisting></informalexample>
    + </simplesect>
    +</chapter>