File Coverage

blib/lib/Scalar/Footnote/Functions.pm

Criterion	Covered	Total	%
statement	6	6	100.0
branch			n/a
condition			n/a
subroutine	2	2	100.0
pod			n/a
total	8	8	100.0

=head1 NAME

Scalar::Footnote::Functions - under-the-hood functions for L

=head1 SYNOPSIS

  # Don't use this module directly!
  # You should use the Scalar::Footnote API to access footnotes cleanly.

  use Scalar::Footnote::Functions qw( set_footnote get_footnote remove_footnote );

  my $ref = [];

  # attach invisible footnote to $ref:
  set_footnote( $ref, 'footnote' );

  # get it back:
  $footnote = get_footnote( $ref );

  # remove it:
  $footnote = remove_footnote( $ref );

  # or you can do things OO-stylee:
  $obj->Scalar::Footnote::set_footnote( $a_value );
  $note = Scalar::Footnote::get_footnote( $obj );
  $note = $obj->Scalar::Footnote::get_footnote;
  $note = $obj->Scalar::Footnote::remove_footnote;

=cut

package Scalar::Footnote::Functions;

use strict;
use warnings;

require Exporter;
require DynaLoader;
require AutoLoader;

our @ISA       = qw( Exporter DynaLoader );
our @EXPORT    = qw( );
our @EXPORT_OK = qw( get_footnote set_footnote remove_footnote );
our $VERSION   = '0.99_02';

bootstrap Scalar::Footnote::Functions $VERSION;

1;

__END__