NAME

Padre::Comment - Padre Comment Support Library

DESCRIPTION

This module provides objects which represent a logical comment style for a programming language and implements a range of logic to assist in locating, counting, filtering, adding and removing comments in a document.

Initially, however, it only acts as a central storage location for the comment styles of supported mime types.

METHODS

registered

my @registered = Padre::Comment->registered;

The registered method returns the list of all registered MIME types that have a comment style distinct from their parent supertype.

get

my $comment = Padre::Comment->get('application/x-perl');

The get method finds a comment for a specific MIME type. This method checks only the specific string and does not follow the superpath of the mime type. For a full powered lookup, use the find method.

Returns a Padre::Comment object or undef if the mime type does not have a distinct comment string.

COPYRIGHT & LICENSE

Copyright 2008-2016 The Padre development team as listed in Padre.pm.

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