summaryrefslogtreecommitdiff
path: root/lib/utf8_heavy.pl
diff options
context:
space:
mode:
authorKarl Williamson <public@khwilliamson.com>2011-05-14 10:07:37 -0600
committerKarl Williamson <public@khwilliamson.com>2011-05-19 10:31:20 -0600
commitfbe6f3cfe96af50ec0bf4a6c1748bf45042d07d5 (patch)
treeed135a29510c2b980f222e6254774ab8548cf3dc /lib/utf8_heavy.pl
parentec2f012870ad64a16921f53f65a691592067bbce (diff)
downloadperl-fbe6f3cfe96af50ec0bf4a6c1748bf45042d07d5.tar.gz
utf8_heavy: Add comments
Diffstat (limited to 'lib/utf8_heavy.pl')
-rw-r--r--lib/utf8_heavy.pl4
1 files changed, 4 insertions, 0 deletions
diff --git a/lib/utf8_heavy.pl b/lib/utf8_heavy.pl
index b3a3a36769..b744b3bfa1 100644
--- a/lib/utf8_heavy.pl
+++ b/lib/utf8_heavy.pl
@@ -70,6 +70,10 @@ sub croak { require Carp; Carp::croak(@_) }
## info we need. Were this to be a subroutine, the 'last' would just
## be a 'return'.
##
+ # If a problem is found $type is returned;
+ # Upon success, a new (or cached) blessed object is returned with
+ # keys TYPE, BITS, EXTRAS, LIST, and NONE with values having the
+ # same meanings as the input parameters.
my $file; ## file to load data from, and also part of the %Cache key.
my $ListSorted = 0;