/ 
Markdent-0.40
River stage two • 5 direct dependents • 14 total dependents
/ Markdent::Role::BalancedEvent

NAME

Markdent::Role::BalancedEvent - A parameterized role for events which can check if they balance another event

VERSION

version 0.40

DESCRIPTION

This role provides behavior for start and end events which can be checked for a balancing event. This includes things like strong, emphasis, and code start/end events.

ROLE PARAMETERS

This role accepts the following parameters:

  • compare => [ ... ]

    This should be a list of attribute names which will be compared between the start and end events.

METHODS

This role provides the following methods:

$event->balances_event($event2)

Given an event, this returns true if two events balance each other. This is done by comparing types (StartCode matches EndCode), as well as the attributes provided in the compare parameter.

BUGS

See Markdent for bug reporting details.

Bugs may be submitted at https://github.com/houseabsolute/Markdent/issues.

I am also usually active on IRC as 'autarch' on irc://irc.perl.org.

SOURCE

The source code repository for Markdent can be found at https://github.com/houseabsolute/Markdent.

AUTHOR

Dave Rolsky <autarch@urth.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2021 by Dave Rolsky.

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

The full text of the license can be found in the LICENSE file included with this distribution.