view release on metacpan or  search on metacpan

utils/grammar-to-pod  view on Meta::CPAN

    my @alt = $command->to_string;

    for my $dir ( 'set', 'get' ) {

        for my $cmd ( sort { $a->{$dir} cmp $b->{$dir} } grep { defined $_->{$dir} } @alt ) {

            push @docs, q{}, sprintf( '%s# %s', $indent, $cmd->{comment} )
              if defined $cmd->{comment};

            my $doc = wrap( $indent, q{    }, $cmd->{$dir} );

            push @docs, q{}
              if length $docs[-1] and substr( $docs[-1], 0, 16 ) ne substr( $doc, 0, 16 );

            push @docs, split( /\n/, $doc );
        }
        push @docs, q{} unless @docs && !length $docs[-1];
    }

    pop @docs while @docs && !length $docs[-1];
}

my $docs = join( "\n", @docs );
$template =~ s/%DOCS%/$docs/;

say $template;


__END__

# ABSTRACT: Image::DS9 API Reference
# PODNAME: Image::DS9::Manual::API.pod

=pod

=for stopwords
XPA
cmap
colorbar
crosshair
dsseso
dsssao
dssstsci
envi
fp
gif
iconify
iis
ixem
jpeg
mecube
minmax
mosaicimage
multiframe
nameserver
nrrd
nvss
pagesetup
pixeltable
png
prefs
rgb
rgbarray
rgbcube
rgbimage
samp
saveimage
shm
sia
skyview
threed
vla
vlss
vo
wcs
xpa
zscale

=head1 DESCRIPTION

L<Image::DS9> provides the user access to C<DS9>'s directives via
methods which closely mirror their syntax.  This document provides the
list of methods, as generated from L<Image::DS9>'s internal grammar

Most methods exactly parallel the B<DS9> B<XPA> commands.  For more
information on what the methods do, or how the arguments affect
things, please consult the B<DS9> documentation.

In general each element in a command is passed as a separate argument
to the method.  For example, to change the binning factor:

  $dsp->bin( factor => 0.2 );

Some commands have more arguments:

  $dsp->bin( smooth => function => 'boxcar' );
  $dsp->bin( smooth => radius => 33 );
  $dsp->bin( about => ( 3, 3 ) );
  $dsp->bin( cols => ( 'rt_x', 'rt_y' ) );

Note the use of the C<=E<gt>> operator to force preceding barewords to be
treated as strings, and the frivolous use of extra parenthesis for
aesthetics.  Some arguments are concatenated to avoid confusion; see
the documentation for the individual methods.

Some commands can query B<DS9> for state information as well as set it.
For example,

        $function = $dsp->bin( smooth => function );

B<Image::DS9> differentiates between the setting and requesting of
values by the presence or absence of the argument containing the information.

Some commands take a hash as their last argument, which contains
attributes which are passed on to B<DS9>.

True Boolean values may be one of the following:  C<1>, C<yes>, C<true>.
False Boolean values may be one of the following:  C<0>, C<no>,
C<false>.  Boolean values returned by a command are always translated
into either C<0> or C<1>.