/ 
Markdent-0.09
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 match balance another event

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.

AUTHOR

Dave Rolsky, <autarch@urth.org>

COPYRIGHT & LICENSE

Copyright 2009-2010 Dave Rolsky, All Rights Reserved.

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