1
0
mirror of https://github.com/rkd77/elinks.git synced 2025-01-03 14:57:44 -05:00

Documented the load_file and save_file methods of Locale::PO.

This commit is contained in:
Kalle Olavi Niemitalo 2006-02-05 19:16:06 +02:00 committed by Kalle Olavi Niemitalo
parent 15d4531f14
commit 970c7f5483

View File

@ -428,6 +428,7 @@ Locale::PO - Perl module for manipulating .po entries from GNU gettext
[$string =] $po->reference([new string]); [$string =] $po->reference([new string]);
[$value =] $po->fuzzy([value]); [$value =] $po->fuzzy([value]);
[$value =] $po->c_format([value]); [$value =] $po->c_format([value]);
[$value =] $po->php_format([value]);
print $po->dump; print $po->dump;
$quoted_string = $po->quote($string); $quoted_string = $po->quote($string);
@ -435,8 +436,10 @@ Locale::PO - Perl module for manipulating .po entries from GNU gettext
$aref = Locale::PO->load_file_asarray(<filename>); $aref = Locale::PO->load_file_asarray(<filename>);
$href = Locale::PO->load_file_ashash(<filename>); $href = Locale::PO->load_file_ashash(<filename>);
$ref = Locale::PO->load_file(<filename>,$ashash);
Locale::PO->save_file_fromarray(<filename>,$aref); Locale::PO->save_file_fromarray(<filename>,$aref);
Locale::PO->save_file_fromhash(<filename>,$href); Locale::PO->save_file_fromhash(<filename>,$href);
Locale::PO->save_file(<filename>,$ref,$fromhash);
=head1 DESCRIPTION =head1 DESCRIPTION
@ -583,6 +586,13 @@ the file. The hash keys are the untranslated strings, so this is a cheap
way to remove duplicates. The method will prefer to keep entries that way to remove duplicates. The method will prefer to keep entries that
have been translated. have been translated.
=item load_file
This method behaves as C<load_file_asarray> if the C<$ashash>
parameter is 0, or as C<load_file_ashash> if C<$ashash> is 1.
Your code will probably be easier to understand if you call either
of those methods instead of this one.
=item save_file_fromarray =item save_file_fromarray
Given a filename and a reference to a list of Locale::PO objects, Given a filename and a reference to a list of Locale::PO objects,
@ -594,6 +604,13 @@ Given a filename and a reference to a hash of Locale::PO objects,
saves those objects to the file, creating a po-file. The entries saves those objects to the file, creating a po-file. The entries
are sorted alphabetically by untranslated string. are sorted alphabetically by untranslated string.
=item save_file
This method behaves as C<save_file_fromarray> if the C<$fromhash>
parameter is 0, or as C<save_file_fromhash> if C<$fromhash> is 1.
Your code will probably be easier to understand if you call either
of those methods instead of this one.
=back =back
=head1 AUTHOR =head1 AUTHOR
@ -636,6 +653,9 @@ Added comments about the fields of Locale::PO objects.
The load_file function binds $/ and $_ dynamically. The load_file function binds $/ and $_ dynamically.
Renamed normalize_str to _normalize_str, and dump_multi_comment to _dump_multi_comment. Renamed normalize_str to _normalize_str, and dump_multi_comment to _dump_multi_comment.
POD changes:
Documented C<load_file> and C<save_file>.
=back =back
=head1 COPYRIGHT AND LICENSE =head1 COPYRIGHT AND LICENSE