POD/Item/Head/Head.pm

Go to the documentation of this file.

package Doxygen::POD::Item::Head;

=head1 NAME

Doxygen::POD::Item::Head - Perl extension for generating Doxygen documentation

=head1 SYNOPSIS

    my  $item = new Doxygen::POD::Item::Head;

=head1 ABSTRACT

A POD =head block.

=head1 DESCRIPTION

=head1 METHODS

=over

=cut

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

use     base    qw(Doxygen::POD::Item);

our $VERSION = '0.01';

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

=item   C<generate($self, %flags)>

Generates output understandable by doxygen to standard output.

=cut

sub generate
{
    my  $self = shift;
    my  $lvl  = ($self->{level} || 1) + 1;
    my  $head = undef;
    
    return if $self->{disabled};
    
    Doxygen::Item::genThing("\n", @_);
    
    Doxygen::Item::genThing
        ("<h$lvl class='POD_head$lvl'>$self->{name}</h$lvl>\n", @_);
    
    my  %flags = @_;
    my  $which = $flags{which} || 'text';
    
    $flags{which} = $which unless defined $flags{which};
        
    Doxygen::Item::genThing($_, %flags)
        for @{$self->text($which)};
}

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

1

__END__

=back

=head1 SEE ALSO

DoxyFilt.pl Doxygen::Item Doxygen::POD::Item

=head1 AUTHOR

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

=head1 COPYRIGHT AND LICENSE

Copyright 2004 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