Add documentation of XFSM::Privates.

lib/XFSM/Privates.pod

@@ -0,0 +1,54 @@
+=head1 NAME
+
+XFSM::Privates - Direct access to XFSM interface from Perl
+
+
+=head1 VERSION
+
+This document describes XFSM version 0.0.1
+
+
+=head1 SYNOPSIS
+
+    use XFSM::Privates;
+
+    my $context XFSM::Privates::initialize_cfsm();
+    XFSM::Privates::reclaim_cfsm($context);
+
+
+=head1 DESCRIPTION
+
+Here be dragons! The following assumes familiarity with the low-level
+interfaces generated by SWIG. See
+L<the SWIG documentation|http://swig.org/Doc2.0/SWIGDocumentation.pdf> for details, chapter 30 in
+general and sections 30.4 and 30.9 in particular.
+
+These bindings are generated with SWIG, using the following command line:
+C<swig -perl5 -const xfsm.i>. This means that SWIG generates proxy classes and
+struture members are available as hash entries. Constants are wrapped with
+constant subs, so that the UPPER C<#define> is available as
+C<XFSM::Privates::UPPER> (not C<$XFSM::Privates::UPPER>). All the functions of
+the C interface are available as subs with the same name in the
+C<XFSM::Privates> namespace.
+
+If the wrapper is loaded with C<use XFSM::Privates> no initialisation or
+destruction is performed. If C<use XFSM> is used
+C<XFSM::Privates::initialize_cfsm()> is called at C<BEGIN> time and the
+returned context is stored in C<$XFSM::context>, and at C<END> time it will be
+destroyed with C<XFSM::reclaim_cfsm()>.
+
+
+=head1 BUGS & LIMITATIONS
+
+No known bugs yet.
+
+
+=head1 SEE ALSO
+
+L<XFSM>, L<the SWIG documentation|http://swig.org/Doc2.0/SWIGDocumentation.pdf>, the XFSM
+documentation.
+
+
+=head1 AUTHOR
+
+Arne SkjE<aelig>rholt C<< <arnsholt@gmail.com> >>