• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1package ANTLR::Runtime;
2
3use strict;
4use warnings;
5
6use version; our $VERSION = qv('0.0.1');
7
81;
9
10__END__
11
12=head1 NAME
13
14ANTLR::Runtime - ANTLR Runtime for Perl 5
15
16
17=head1 VERSION
18
19This documentation refers to ANTLR::Runtime version 0.0.1
20
21
22=head1 SYNOPSIS
23
24    use <Module::Name>;
25    # Brief but working code example(s) here showing the most common usage(s)
26
27    # This section will be as far as many users bother reading
28    # so make it as educational and exemplary as possible.
29
30
31=head1 DESCRIPTION
32
33A full description of the module and its features.
34May include numerous subsections (i.e. =head2, =head3, etc.)
35
36
37=head1 SUBROUTINES/METHODS
38
39A separate section listing the public components of the module's interface.
40These normally consist of either subroutines that may be exported, or methods
41that may be called on objects belonging to the classes that the module provides.
42Name the section accordingly.
43
44In an object-oriented module, this section should begin with a sentence of the
45form "An object of this class represents...", to give the reader a high-level
46context to help them understand the methods that are subsequently described.
47
48
49=head1 DIAGNOSTICS
50
51A list of every error and warning message that the module can generate
52(even the ones that will "never happen"), with a full explanation of each
53problem, one or more likely causes, and any suggested remedies.
54(See also "Documenting Errors" in Chapter 13.)
55
56
57=head1 CONFIGURATION AND ENVIRONMENT
58
59A full explanation of any configuration system(s) used by the module,
60including the names and locations of any configuration files, and the
61meaning of any environment variables or properties that can be set. These
62descriptions must also include details of any configuration language used.
63(See also "Configuration Files" in Chapter 19.)
64
65
66=head1 DEPENDENCIES
67
68A list of all the other modules that this module relies upon, including any
69restrictions on versions, and an indication whether these required modules are
70part of the standard Perl distribution, part of the module's distribution,
71or must be installed separately.
72
73
74=head1 INCOMPATIBILITIES
75
76A list of any modules that this module cannot be used in conjunction with.
77This may be due to name conflicts in the interface, or competition for
78system or program resources, or due to internal limitations of Perl
79(for example, many modules that use source code filters are mutually
80incompatible).
81
82
83=head1 BUGS AND LIMITATIONS
84
85A list of known problems with the module, together with some indication
86whether they are likely to be fixed in an upcoming release.
87
88Also a list of restrictions on the features the module does provide:
89data types that cannot be handled, performance issues and the circumstances
90in which they may arise, practical limitations on the size of data sets,
91special cases that are not (yet) handled, etc.
92
93The initial template usually just has:
94
95There are no known bugs in this module.
96Please report problems to <Maintainer name(s)>  (<contact address>)
97Patches are welcome.
98
99=head1 AUTHOR
100
101Ronald Blaschke (ron@rblasch.org)
102
103
104=head1 LICENCE AND COPYRIGHT
105
106Copyright (c) 2008 Ronald Blaschke (ron@rblasch.org).  All rights reserved.
107
108Based on ANTLR Java Runtime by Terence Parr.
109
110This module is free software; you can redistribute it and/or
111modify it under the same terms as Perl (see L<perlartistic>)
112or ANTLR (see L<http://www.antlr.org/license.html>) itself.
113
114This program is distributed in the hope that it will be useful,
115but WITHOUT ANY WARRANTY; without even the implied warranty of
116MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
117