Skip to content

Commit 1c82dcc

Browse files
author
Chris White
committed
Updated documentation [minor]
1 parent 47ac443 commit 1c82dcc

File tree

2 files changed

+11
-40
lines changed

2 files changed

+11
-40
lines changed

lib/XML/Axk/App.pm

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -248,12 +248,6 @@ Print the version of axk and exit
248248
249249
Christopher White, C<cxwembedded at gmail.com>
250250
251-
=head1 BUGS
252-
253-
Please report any bugs or feature requests to C<bug-xml-axk at rt.cpan.org>, or through
254-
the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=XML-Axk>. I will be notified, and then you'll
255-
automatically be notified of progress on your bug as I make changes.
256-
257251
=head1 SUPPORT
258252
259253
You can find documentation for this module with the perldoc command.
@@ -272,18 +266,6 @@ L<https://github.com/cxw42/axk>
272266
273267
L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=XML-Axk>
274268
275-
=item * AnnoCPAN: Annotated CPAN documentation
276-
277-
L<http://annocpan.org/dist/XML-Axk>
278-
279-
=item * CPAN Ratings
280-
281-
L<http://cpanratings.perl.org/d/XML-Axk>
282-
283-
=item * Search CPAN
284-
285-
L<http://search.cpan.org/dist/XML-Axk/>
286-
287269
=back
288270
289271
=head1 LICENSE AND COPYRIGHT

lib/XML/Axk/Core.pm

Lines changed: 11 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,8 @@ my $scriptnumber = 0;
2929
# }}}1
3030
# Loading =============================================================== {{{1
3131

32-
# Load the named script file from disk, but do not execute it
32+
# Load the named script file from disk, but do not execute it.
33+
# TODO permit specifying an Ln?
3334
# @param $self
3435
# @param $fn {String} Filename to load
3536
sub load_script_file {
@@ -51,6 +52,7 @@ sub load_script_file {
5152
} #load_script_file
5253

5354
# Load the given text, but do not execute it.
55+
# TODO permit specifying a specific Ln?
5456
# @param $self
5557
# @param $text {String} The source text, **which load_script_text may modify.**
5658
# @param $fn {String} Filename to use in debugging messages
@@ -116,6 +118,7 @@ files.
116118
\b\h*;? # permit trailers for ergonomics
117119
}mx;
118120

121+
# Split the file into individual Ln blocks
119122
while( $text =~ m/$RE_Ln/g ) {
120123
my @idxes=($-[0], $+[0]);
121124
my $lang = $1;
@@ -144,7 +147,7 @@ files.
144147
$length_delta -= length($removed);
145148

146149
my $replacement = '';
147-
$has_lang = 1;
150+
$has_lang = true;
148151

149152
# End an existing capture if we're switching languages
150153
if($curr_trailer) {
@@ -186,7 +189,7 @@ files.
186189
#say "pos = $oldpos; Delta pos = $length_delta";
187190
pos($text) = $oldpos + $length_delta;
188191
}
189-
} #foreach lang
192+
} #foreach Ln block
190193

191194
$text .= "\n" unless substr($text, length($text)-1) eq "\n";
192195
$text .= "$curr_trailer\n" if $curr_trailer;
@@ -478,14 +481,6 @@ Constructor. Takes a hash ref of options
478481
479482
Christopher White, C<cxwembedded at gmail.com>
480483
481-
=head1 BUGS
482-
483-
Please report any bugs or feature requests to C<bug-xml-axk at rt.cpan.org>, or
484-
through the web interface at
485-
L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=XML-Axk>. I will be notified,
486-
and then you'll automatically be notified of progress on your bug as I make
487-
changes.
488-
489484
=head1 SUPPORT
490485
491486
You can find documentation for this module with the perldoc command.
@@ -504,19 +499,13 @@ L<https://github.com/cxw42/axk>
504499
505500
L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=XML-Axk>
506501
507-
=item * AnnoCPAN: Annotated CPAN documentation
508-
509-
L<http://annocpan.org/dist/XML-Axk>
510-
511-
=item * CPAN Ratings
512-
513-
L<http://cpanratings.perl.org/d/XML-Axk>
514-
515-
=item * Search CPAN
502+
=back
516503
517-
L<http://search.cpan.org/dist/XML-Axk/>
504+
=head1 NOTE
518505
519-
=back
506+
I just recently found out about L<Web::Scraper>, which has some overlapping
507+
functionality. However, XML::Axk is targeted specifically at XML, rather
508+
than HTML, and should eventually support dedicated, non-Perl script languages.
520509
521510
=head1 LICENSE AND COPYRIGHT
522511

0 commit comments

Comments
 (0)