Script/Filter/Filter.pm

Go to the documentation of this file.

package Doxygen::Script::Filter;

=head1 NAME

Doxygen::Script::Filter - Perl extension for generating Doxygen documentation

=head1 SYNOPSIS

Generally this class will be instantiated:
    
    my  $filter = new Doxygen::Script::Filter($path);

and used within one of the other Doxygen:: internal classes.

The user will normally invoke this filter by aliasing and configuring
it during an invocation of DoxyFilt.pl.  DoxyFilt.pl takes useful
default settings from the Doxygen::Source module.

By default, Doxygen::Source pre-configures both Windows batch files
and *NIX shell scripts.  The equivalent DoxyFilt.pl command-line
arguments would be:

    DoxyFilt.pl --alias   Batch=Script
                --docs    Batch=qr(\.(?:bat|cmd)$)i
                --comment Batch=qr(^\s*rem ?(.*)$)im
                --alias   Shell=Script
                --docs    Shell=qr(\.(?:ba|c|k|z)?sh$)i
                --comment Shell=qr(^\s*#{2,3}(?!#) ?(.*)$)m
                --check   Shell=qr(^#!/bin/(?:ba|c|k|z)?sh\b)

allowing, of course, for the quoting of characters to get past the
command-line interpreter and the fact that the current codebase probably
doesn't handle the regular expression terminal qr()im flags (oops).
       
=head1 ABSTRACT

Simplistic filter for scripts, whether DOS/Windows
batch files or *NIX shell scripts.

=head1 DESCRIPTION

Generates a Doxygen file comment block.
Pulls out whatever comments are marked via the
basic comment pattern mechanism supported by C<Doxygen::Source>.

May at some point create a script group and mark therein.

=head1 METHODS

=over

=cut

use     5.005;  # just to pick something, but not really tested
use     strict;
use     warnings;

use     base qw(Doxygen::Filter);

our $VERSION = '0.01';

###########################################################################
###########################################################################

=item   C<parse($self, $text, $source)>

Parse a source file.

Attach results (C<Doxygen::Item> objects) to C<Doxygen::Source> object.

=cut

sub parse       # $self, $text, $source
{
    my  $self = shift;
    
    $self->parseCmnts(@_);
}

###########################################################################
###########################################################################

1

__END__

=back

=head1 SEE ALSO

DoxyFilt.pl Doxygen::Filter

=head1 AUTHOR

Marc M. Adkins, L<mailTo:Perl@Doorways.org>

=head1 COPYRIGHT AND LICENSE

Copyright 2004-2010 by Marc M. Adkins

This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.

=cut