diff options
Diffstat (limited to 'ext/Pod-Html/lib/Pod/Html/Util.pm')
| -rw-r--r-- | ext/Pod-Html/lib/Pod/Html/Util.pm | 21 |
1 files changed, 15 insertions, 6 deletions
diff --git a/ext/Pod-Html/lib/Pod/Html/Util.pm b/ext/Pod-Html/lib/Pod/Html/Util.pm index 76d7a47015..9f33bff91e 100644 --- a/ext/Pod-Html/lib/Pod/Html/Util.pm +++ b/ext/Pod-Html/lib/Pod/Html/Util.pm @@ -2,7 +2,7 @@ package Pod::Html::Util; use strict; require Exporter; -our $VERSION = 1.31; # Please keep in synch with lib/Pod/Html.pm +our $VERSION = 1.32; # Please keep in synch with lib/Pod/Html.pm $VERSION = eval $VERSION; our @ISA = qw(Exporter); our @EXPORT_OK = qw( @@ -30,12 +30,20 @@ Pod::Html::Util - helper functions for Pod-Html =head1 SUBROUTINES -=head2 C<parse_command_line()> - -TK +B<Note:> While these functions are importable on request from +F<Pod::Html::Util>, they are specifically intended for use within (a) the +F<Pod-Html> distribution (modules and test programs) shipped as part of the +Perl 5 core and (b) other parts of the core such as the F<installhtml> +program. These functions may be modified or relocated within the core +distribution -- or removed entirely therefrom -- as the core's needs evolve. +Hence, you should not rely on these functions in situations other than those +just described. =cut +# parse_command_line will be moved back to lib/Pod/Html.pm in a subsequent +# p.r. and will be documented then and there + sub parse_command_line { my $globals = shift; my ($opt_backlink,$opt_cachedir,$opt_css,$opt_flush,$opt_header, @@ -98,7 +106,7 @@ sub parse_command_line { =head2 C<usage()> -TK +Display customary Pod::Html usage information. =cut @@ -149,7 +157,8 @@ END_OF_USAGE =head2 C<unixify()> -TK +Ensure that F<Pod::Html>'s internals and tests handle paths consistently +across Unix, Windows and VMS. =cut |