File: Parser.pod

package info (click to toggle)
libcommonmark-perl 0.310100-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 220 kB
  • sloc: perl: 291; makefile: 3
file content (46 lines) | stat: -rw-r--r-- 1,019 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
=head1 NAME

CommonMark::Parser - Push parser interface

=head1 SYNOPSIS

    my $parser = CommonMark::Parser->new;
    $parser->feed($string);
    $parser->feed($another_string);
    my $doc = $parser->finish;

=head1 DESCRIPTION

C<CommonMark::Parser> provides a push parser interface to parse CommonMark
documents.

=head2 new

   my $parser = CommonMark::Parser->new( [$options] );

Creates a parser object. C<$options> is a bit field containing the parser
options. It defaults to zero (C<OPT_DEFAULT>). See
L<CommonMark/"Parser options">.

=head2 feed

    $parser->feed($string);

Feeds a part of the input Markdown to the parser.

=head2 finish

    my $doc = $parser->finish;

Parses a CommonMark document from the strings added with C<feed> returning
the L<CommonMark::Node> of the document root.

=head1 COPYRIGHT

This software is copyright (C) by Nick Wellnhofer.

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

=cut