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